1
0
Fork 0
forked from docs/team-docs

📝 Reusable attributes: Fix xref, update example

This commit makes two primary changes:

- Fix a broken `xref` link to the Fedora DEI Team documentation, which
  recently changed Antora component names from `/diversity-inclusion/`
  to `/dei/`.
- Update the example of an attributes file using the latest example from
  the Fedora DEI Team. This is a more comprehensive example of how to
  use attributes/partials based on the current practice in the DEI Team.

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
This commit is contained in:
Justin Wheeler 2023-09-28 23:31:29 +02:00
commit 04c277f83c
Signed by untrusted user: jflory7
GPG key ID: 7748B15FA8FA4C7E

View file

@ -23,8 +23,8 @@ For these and more use cases, *attributes* allow you to define some metadata in
There are two requirements for your Fedora Documentation project to use attributes.
. Import attributes in your AsciiDoc file
. Create an attributes file
. Import attributes in your AsciiDoc file
[[attributes-file]]
@ -44,16 +44,43 @@ The example below shows a globally reusable attributes file in the `ROOT` module
└── attributes.adoc
----
This is an example `attributes.adoc` from the xref:diversity-inclusion::index.adoc[Fedora Diversity & Inclusion Team]:
This is an example `attributes.adoc` from the xref:dei::index.adoc[Fedora DEI Team]:
[source,adoc]
----
// This is a data store of information about the Fedora DEI team.
// Team name:
:team_name: Fedora Diversity, Equity, & Inclusion (DEI) Team
// Team summary:
:team_summary: The {team_name} encourages, supports, and enables DEI in the Fedora community. We work with the community to create an environment where everyone feels empowered to be a part of and contribute to the Fedora Project.
// Team page URL:
:team_url: https://docs.fedoraproject.org/en-US/dei/
// Team activity status.
// Choose from: Active, Inactive
:team_status: Active
// Preferred asynchronous communication channel
:team_asynch_communication: https://discussion.fedoraproject.org/tag/dei-team
// Preferred synchronous communication channel
:team_synch_communication: https://matrix.to/#/#dei:fedoraproject.org
// Issue tracker
:team_issue_tracker: https://gitlab.com/fedora/dei/home/
// Meetings
:team_meetings: https://apps.fedoraproject.org/calendar/diversity-team/
// Imported from our old attributes file.
:COMMBLOG: https://communityblog.fedoraproject.org
:FISCALYEAR: FY20
:FISCALYEAR: FY23
:FWIKI: https://fedoraproject.org/wiki
:YEAR: 2020
:MAILINGLIST: https://lists.fedoraproject.org/archives/list/diversity@lists.fedoraproject.org/
:MAJOROSVER: 32
:YEAR: 2023
:MAJOROSVER: 39
----
@ -79,7 +106,7 @@ After creating an attributes file *AND* import attributes, reference the attribu
{ATTRIBUTE}
----
See this example from the Fedora Diversity & Inclusion Team:
See this example from the Fedora DEI Team:
[source,adoc]
----