Commit graph

5 commits

Author SHA1 Message Date
de0d38c5a7
Docs: Convert all docs to native AsciiDoc
This commit is a significant refactor of all the Fedora Council
documentation into full, native AsciiDoc. This includes following
conventions commonly associated with AsciiDoc, such as the one sentence
per line convention and using more internal `xref` links across pages.
It also introduces explicit link anchors on all headings.

This commit is mostly invisible to the reader. All lines across the
Antora component are now written on one sentence per line, as per the
standard AsciiDoc convention. Following this convention makes future git
diffs easier to read when it comes to actual changes in meaning.

Additionally, where applicable, I updated names and titles of roles that
have since been changed, e.g. "Fedora Community Action & Impact
Coordinator" to "Fedora Community Architect".

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
2023-10-19 23:28:55 -04:00
8a66455ed5
docs(council): Replace "Council" with {team_name}
This commit changes almost every occurrence of "Council" and "Fedora
Council" with `{team_name}`, an Antora macro that resolves to "Fedora
Council". This continues the integration work with the team profile
introduced in previous commits. It ensures consistent use of the Fedora
Council name in our documents and may also contribute to a slight boost
in search engine optimization.

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
2023-10-14 21:10:55 -05:00
bdaaa7a85d
docs(council): Introduce macros via Antora partials
NOTE: This commit does NOT change content, policy, or the substance of
any written documentation that requires Fedora Council review. This
change only impacts changes related to the Antora toolchain.

This commit integrates the team directory profile that was introduced a
few years ago into the Fedora Council documentation. This makes several
common URLs used across the Fedora Council Antora component accessible
as macros. Instead of hard-coding the same URL across all of the Fedora
Council documentation, the macros can be used to more easily re-use the
same URL consistently across multiple pages.

This commit is one of several that gradually refactors the Fedora
Council documentation to properly fit into an AsciiDoc and Antora
workflow.

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
2023-10-14 20:32:53 -05:00
f705cdf7ac
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) <jwf@redhat.com>
2023-02-08 17:46:54 +01:00
Ben Cotton
8995cc68c6 Add documentation on how we use tickets
I would like to bulldoze this and start over, but for now let's at least document the current state.
2020-08-26 15:12:54 -04:00