PR#175: Meta: Use partials for reusable data about the Council - Fedora-Council/council-docs

Fedora-Council / council-docs

#175 Meta: Use partials for reusable data about the Council

Merged 2 years ago by bcotton. Opened 2 years ago by jflory7.

Fedora-Council/ jflory7/council-docs add/partials-attributes into main

Meta: Use partials for reusable data about the Council

Justin W. Flory (he/him) • 2 years ago

f705cdf

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Contacting the Fedora Council`

		`The Fedora Council uses three platforms for communications, one for asynchronous, one for asynchronous, and one for decision-making.`

council/modules/ROOT/pages/fpl.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= The Fedora Project Leader`
		`// Remember the one-sentence-per-line convention when editing this page.`
		`// https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line`

council/modules/ROOT/pages/historical/board_stable_updates_vision.adoc

file modified

+2 -2

		`@@ -1,5 +1,5 @@`
		`- include::{partialsdir}/historical_warning.adoc[]`
		`-`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+ include::ROOT:partial$historical_warning.adoc[]`

		`[NOTE]`
		`====`

council/modules/ROOT/pages/index.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Fedora Council Charter`

		`image::council-logo-500px.png[float="right"]`

council/modules/ROOT/pages/policy/community-publishing-platforms.adoc

file modified

+4 -1

		`@@ -1,5 +1,7 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Community Publishing Platforms`
		`- Justin W. Flory, Fedora Council, Fedora Community, and others <council-discuss@lists.fedoraproject.org>`
		`+ Justin W. Flory, Fedora Council, Fedora Community, and others`
		`v1.1.1, 2020-10-02`
		`:toc:`

		`@@ -43,6 +45,7 @@`
		`** https://telegram.me/fedoranews`
		`** https://www.instagram.com/thefedoraproject/`

		`+`
		`[[content]]`
		`== What content is appropriate for Platforms?`

council/modules/ROOT/pages/policy/policy-change-policy.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Policy Change policy`

		`Proposed changes to Fedora Council policies must be publicly announced on the https://discussion.fedoraproject.org/c/project/council-discuss/60[Council Discussions category on Fedora Discussion] and in a https://communityblog.fedoraproject.org/[Fedora Community Blog] post in order to get feedback from the community.`

council/modules/ROOT/pages/procedures/tickets.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Council ticket queue`

		`The Fedora Council uses a https://pagure.io/Fedora-Council/tickets/issues[ticket queue] to track decisions and other work.`

council/modules/ROOT/pages/procedures/welcome.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Welcome to Council`

		`Welcome to the Fedora Council!`

council/modules/ROOT/partials/attributes.adoc

file added

		`@@ -0,0 +1,6 @@`
		`+ :COMMBLOG: https://communityblog.fedoraproject.org`
		`+ :FWIKI: https://fedoraproject.org/wiki`
		`+ :URL-CHAT: https://matrix.to/#/#council:fedoraproject.org`
		`+ :URL-DISCUSS: https://discussion.fedoraproject.org/tag/council`
		`+ :URL-TICKETS: https://pagure.io/Fedora-Council/tickets/issues`
		`+ :YEAR: 2023`

council/modules/ROOT/partials/historical_warning.adoc ~~council/modules/ROOT/pages/_partials/historical_warning.adoc~~

file renamed

file was moved with no change to the file

engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc

file modified

+4 -4

		`@@ -20,10 +20,10 @@`
		`:team_status: Active`

		`// Preferred Asynch communication channel (mailing list, discussion.fp.o, none, etc)`
		`- :team_asynch_communication: https://lists.fedoraproject.org/admin/lists/council-discuss.lists.fedoraproject.org/`
		`+ :team_asynch_communication: https://discussion.fedoraproject.org/tag/council`

		`- // Preferred Synch (IRC channel, telegram, etc, none)`
		`- :team_synch_communication: #fedora-council`
		`+ // Preferred Synch (Matrix room, none, etc.)`
		`+ :team_synch_communication: #council:fedoraproject.org`

		`// Issue tracker`
		`:team_issue_tracker: https://pagure.io/Fedora-Council/tickets`
		`@@ -32,4 +32,4 @@`
		`:team_meetings: https://fedoraproject.org/wiki/Council_Meetings`

		`// Any other information?`
		`- :team_other: Lorem ipsum`
		`\ No newline at end of file`
		`+ :team_other: Lorem ipsum`

mindshare/modules/ROOT/partials/TEMPLATE_team_info.adoc

file modified

+4 -4

		`@@ -20,10 +20,10 @@`
		`:team_status: Active`

		`// Preferred Asynch communication channel (mailing list, discussion.fp.o, none, etc)`
		`- :team_asynch_communication: https://lists.fedoraproject.org/admin/lists/council-discuss.lists.fedoraproject.org/`
		`+ :team_asynch_communication: https://discussion.fedoraproject.org/tag/council`

		`- // Preferred Synch (IRC channel, telegram, etc, none)`
		`- :team_synch_communication: #fedora-council`
		`+ // Preferred Synch (Matrix room, none, etc.)`
		`+ :team_synch_communication: #council:fedoraproject.org`

		`// Issue tracker`
		`:team_issue_tracker: https://pagure.io/Fedora-Council/tickets`
		`@@ -32,4 +32,4 @@`
		`:team_meetings: https://fedoraproject.org/wiki/Council_Meetings`

		`// Any other information?`
		`- :team_other: Lorem ipsum`
		`\ No newline at end of file`
		`+ :team_other: Lorem ipsum`

project/modules/ROOT/pages/initiatives.adoc

file modified

		`@@ -1,3 +1,5 @@`
		`+ include::ROOT:partial$attributes.adoc[]`
		`+`
		`= Current 12-18 Month Community Initiatives`
		`:page-aliases: objectives.adoc`

jflory7 commented 2 years ago

This commit adopts the current best-practice for using partials in
Antora within the Council docs, and it also adds an attributes partial
that includes common metadata used across the Council docs. The partials
are not yet used across the Council docs, but the attributes partial is
imported into the headers of multiple documents.

This is setting the stage to make updating things like our Discourse,
Matrix, and other comms places easier to maintain and update.