From f705cdf7ac516c726d7439aed9798e265b2be890 Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Feb 08 2023 16:46:54 +0000 Subject: Meta: Use partials for reusable data about the Council 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. Signed-off-by: Justin W. Flory (he/him) --- diff --git a/council/modules/ROOT/pages/_partials/historical_warning.adoc b/council/modules/ROOT/pages/_partials/historical_warning.adoc deleted file mode 100644 index beb28a7..0000000 --- a/council/modules/ROOT/pages/_partials/historical_warning.adoc +++ /dev/null @@ -1,34 +0,0 @@ -//// - -This message needs to be included in any document in the "historical" -section, so that people are not mislead. - -Add the following line verbatim to the top of any such document: - -include::{partialsdir}/historical_warning.adoc[] - -Please also include a [NOTE] adminition; -something like the following example: - -[NOTE] -==== -This is a Fedora Board policy, -adopted in 2010. -It shows how -_something happened or whatever_ -but is now irrelevant because -_something changed_. -==== - - -//// - -[CAUTION] -==== -This page preserves a document -from Fedora's past. -It may not -(and probably _does not_) -reflect current policy -or Fedora Project practices. -==== diff --git a/council/modules/ROOT/pages/contact.adoc b/council/modules/ROOT/pages/contact.adoc index 138bcea..0513d70 100644 --- a/council/modules/ROOT/pages/contact.adoc +++ b/council/modules/ROOT/pages/contact.adoc @@ -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. diff --git a/council/modules/ROOT/pages/fpl.adoc b/council/modules/ROOT/pages/fpl.adoc index d0c533e..01bc441 100644 --- a/council/modules/ROOT/pages/fpl.adoc +++ b/council/modules/ROOT/pages/fpl.adoc @@ -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 diff --git a/council/modules/ROOT/pages/historical/board_stable_updates_vision.adoc b/council/modules/ROOT/pages/historical/board_stable_updates_vision.adoc index 42c2efb..2a18149 100644 --- a/council/modules/ROOT/pages/historical/board_stable_updates_vision.adoc +++ b/council/modules/ROOT/pages/historical/board_stable_updates_vision.adoc @@ -1,5 +1,5 @@ -include::{partialsdir}/historical_warning.adoc[] - +include::ROOT:partial$attributes.adoc[] +include::ROOT:partial$historical_warning.adoc[] [NOTE] ==== diff --git a/council/modules/ROOT/pages/index.adoc b/council/modules/ROOT/pages/index.adoc index 22448c9..95f24d9 100644 --- a/council/modules/ROOT/pages/index.adoc +++ b/council/modules/ROOT/pages/index.adoc @@ -1,3 +1,5 @@ +include::ROOT:partial$attributes.adoc[] + = Fedora Council Charter image::council-logo-500px.png[float="right"] diff --git a/council/modules/ROOT/pages/policy/community-publishing-platforms.adoc b/council/modules/ROOT/pages/policy/community-publishing-platforms.adoc index 9c8e052..c0e0946 100644 --- a/council/modules/ROOT/pages/policy/community-publishing-platforms.adoc +++ b/council/modules/ROOT/pages/policy/community-publishing-platforms.adoc @@ -1,5 +1,7 @@ +include::ROOT:partial$attributes.adoc[] + = Community Publishing Platforms -Justin W. Flory, Fedora Council, Fedora Community, and others +Justin W. Flory, Fedora Council, Fedora Community, and others v1.1.1, 2020-10-02 :toc: @@ -43,6 +45,7 @@ Community Publishing Platforms include, but are not limited to, the following ex ** https://telegram.me/fedoranews ** https://www.instagram.com/thefedoraproject/ + [[content]] == What content is appropriate for Platforms? diff --git a/council/modules/ROOT/pages/policy/policy-change-policy.adoc b/council/modules/ROOT/pages/policy/policy-change-policy.adoc index 26f19e7..cdb1855 100644 --- a/council/modules/ROOT/pages/policy/policy-change-policy.adoc +++ b/council/modules/ROOT/pages/policy/policy-change-policy.adoc @@ -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. diff --git a/council/modules/ROOT/pages/procedures/tickets.adoc b/council/modules/ROOT/pages/procedures/tickets.adoc index 5a19e5b..0ae3075 100644 --- a/council/modules/ROOT/pages/procedures/tickets.adoc +++ b/council/modules/ROOT/pages/procedures/tickets.adoc @@ -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. diff --git a/council/modules/ROOT/pages/procedures/welcome.adoc b/council/modules/ROOT/pages/procedures/welcome.adoc index 0e51526..425dca2 100644 --- a/council/modules/ROOT/pages/procedures/welcome.adoc +++ b/council/modules/ROOT/pages/procedures/welcome.adoc @@ -1,3 +1,5 @@ +include::ROOT:partial$attributes.adoc[] + = Welcome to Council Welcome to the Fedora Council! diff --git a/council/modules/ROOT/partials/attributes.adoc b/council/modules/ROOT/partials/attributes.adoc new file mode 100644 index 0000000..5a942e0 --- /dev/null +++ b/council/modules/ROOT/partials/attributes.adoc @@ -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 diff --git a/council/modules/ROOT/partials/historical_warning.adoc b/council/modules/ROOT/partials/historical_warning.adoc new file mode 100644 index 0000000..beb28a7 --- /dev/null +++ b/council/modules/ROOT/partials/historical_warning.adoc @@ -0,0 +1,34 @@ +//// + +This message needs to be included in any document in the "historical" +section, so that people are not mislead. + +Add the following line verbatim to the top of any such document: + +include::{partialsdir}/historical_warning.adoc[] + +Please also include a [NOTE] adminition; +something like the following example: + +[NOTE] +==== +This is a Fedora Board policy, +adopted in 2010. +It shows how +_something happened or whatever_ +but is now irrelevant because +_something changed_. +==== + + +//// + +[CAUTION] +==== +This page preserves a document +from Fedora's past. +It may not +(and probably _does not_) +reflect current policy +or Fedora Project practices. +==== diff --git a/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc b/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc index 700643c..377a230 100644 --- a/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc +++ b/engineering/modules/ROOT/partials/TEMPLATE_team_info.adoc @@ -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 diff --git a/mindshare/modules/ROOT/partials/TEMPLATE_team_info.adoc b/mindshare/modules/ROOT/partials/TEMPLATE_team_info.adoc index 700643c..377a230 100644 --- a/mindshare/modules/ROOT/partials/TEMPLATE_team_info.adoc +++ b/mindshare/modules/ROOT/partials/TEMPLATE_team_info.adoc @@ -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 diff --git a/project/modules/ROOT/pages/initiatives.adoc b/project/modules/ROOT/pages/initiatives.adoc index 3ae05d8..99b68c0 100644 --- a/project/modules/ROOT/pages/initiatives.adoc +++ b/project/modules/ROOT/pages/initiatives.adoc @@ -1,3 +1,5 @@ +include::ROOT:partial$attributes.adoc[] + = Current 12-18 Month Community Initiatives :page-aliases: objectives.adoc