Reutilizar atributos

Equipo de Documentación de Fedora <https://discussion.fedoraproject.org/tag/docs> v0.0.1, 2024-06-25

Esta página explica como utilizar metadatos reutilizables, o atributos, a lo largo de múltiples documentos AsciiDoc en la Documentación de Fedora.

¿Por qué atributos reutilizables?

A veces puede desear utilizar los mismos datos a través de distintos documentos AsciiDoc. Algunos ejemplos están debajo:

  • Versión de liberaciones (p. ej. Fedora N)

  • Prefijos o sufijos de URL (p. ej. https://pagure.io/fesco/issues/)

  • Fechas y horas (p. ej. año actual, como 2020)

Para estos y más casos de uso, los atributos le permiten definir algunos metadatos en un único sitio, y reutilizarlos en múltiples lugares.

Vista general

Hay dos requerimientos para su proyecto de Documentación de Fedora para utilizar atributos.

  1. Crear un archivo de atributos

  2. Importar atributos dentro de su archivo AsciiDoc

Crear archivo de atributos

Primero, inicialice un archivo attribute.adoc para cualquier módulo. El ejemplo a continuación muestra un archivo de atributos globalmente reutilizables dentro del módulo ROOT:

.
└── RAÍZ
    ├── nav.adoc
    ├── pages
    │   └── index.adoc
    └── partials
        └── attributes.adoc

Esto es un ejemplo de attributes.adoc desde el Equipo Fedora DEI:

// Esto es un almacenaje de datos de información sobre el equipo Fedora DEI.

// Nombre de equipo:
:team_name: Equipo de Diversidad, Equidad, e Inclusión de Fedora (DEI)

// Resumen del equipo:
:team_summary: el {team_name} fomenta, apoya y facilita la diversidad, inclusión e inclusión (DEI) en la comunidad de Fedora. Trabajamos con la comunidad para crear un entorno donde todos se sientan empoderados para formar parte y contribuir al Proyecto Fedora.

// Team page URL:
:team_url: https://docs.fedoraproject.org/es/dei/

// Team activity status.
// Choose from: Active, Inactive
:team_status: Activo

// Canal de comunicación asincrónico preferido
:team_asynch_communication: https://discussion.fedoraproject.org/tag/dei-team

// Preferred synchronous communication channel
:team_synch_communication: https://matrix.to/#/#dei:fedoraproject.org

// Seguimiento de incidencia
:team_issue_tracker: https://gitlab.com/fedora/dei/home/

// Encuentros
:team_meetings: https://apps.fedoraproject.org/calendar/diversity-team/

// Importado desde su archivo de los atributos antiguos.
:COMMBLOG: https://communityblog.fedoraproject.org
:FISCALYEAR: FY23
:FWIKI: https://fedoraproject.org/wiki
:YEAR: 2023
:MAJOROSVER: 39

Importar atributos

Después, importe el archivo de atributos a su documento AsciiDoc. Coloque esta macro en la línea superior hará el resto:

include::ROOT:partial$attributes.adoc[]

Utilizar atributos en documentación

Tras crear un archivo de atributos E importar atributos, referencie los atributos en documentos AsciiDoc con la sintaxis siguiente:

{ATTRIBUTE}

Consulte este ejemplo desde el Equipo DEI de Fedora:

Se requiere *Consenso completo* para aprobar procesos nuevos, hace cambios
en normativas existentes del equipo, y etiquetado requerido
https://budget.fedoraproject.org/budget/{FISCALYEAR}/d-i.html[D&I budget].

Want to help? Learn how to contribute to Fedora Docs ›