Cree un módulo de documentación nueva
Esta sección describe como añadir una pieza completamente nueva de documentación que cubre un área nueva en sí completamente. Esto amplía varias páginas y está asociada usualmente con la creación de un repositorio nuevo, dedicado. Un entorno de trabajo local es mejor adaptado para este. Pero además es posible utilizar el IDE web de varias forjas GIT.
Antes de que comienza a compartir este procedimiento, revise todos los requisitos listados en Prerequisitos.
Configuración del repositorio de documentación
| Aunque puede crear un nuevo repositorio o utilizar uno existente, le recomendamos que empiece desde el repositorio de plantillas proporcionado si no está familiarizado con Antora. |
Cree su nuevo repositorio para el nuevo conjunto de documentación, o pídale a alguien que cree uno por usted. Puede alojar este repositorio en cualquier lugar, pero le recomendamos usar GitLab donde puede usar los grupos de Fedora para controlar el acceso de escritura al repositorio. Dependiendo del tema, puede ser preferible alojarlo en Fedora Docs namespace.
En GitLab, puedes utilizar Nuevo proyecto > Crear a partir de plantilla > Grupo y elegir Plantilla de documentación en la lista.
Si no utilizas GitLab, clona el repositorio plantilla repositorio manualmente y copia el contenido a tu nuevo repositorio.
📄 antora.yml
📄 site.yml
📂 modules
📂 ROOT
📄 nav.adoc
📂 pages
📄 index.adoc
📄 another-page.adoc
En el repositorio nuevo, edite el archivo de configuración antora.yml en la raíz del repositorio. El archivo contiene comentarios que indican cuales partes necesita cambiar. Como mínimo, cambie siempre el nombre y el título.
El name (nombre) es lo que definirá la URL final de su documentación. En el ejemplo: docs.fedoraproject.org/es/<name>/
|
Además, edite el archivo de configuración site.yml. Tenga en cuenta que este archivo sólo se utilizó cuando se construye una vista previa local de su conjunto de contenidos — en el sitio web es sustituido por la configuración de todo el sitio site.yml. Las únicas directivas que necesitas editar en este archivo son title y start_page.
En este punto, la configuración inicial está completa. Usted puede empujar estos cambios en el repositorio de nueva creación (o hacer una solicitud de extracción si usted no tiene los derechos necesarios) y empezar a trabajar en la escritura de la documentación real.
Escribiendo documentación
Algunos enlaces a documentación útil:
Si su documentación se compone de varias páginas, puede listarlas en nav.adoc. Este archivo se utilizará para construir el menú de navegación en la parte izquierda de docs.fp-o.
Mientras escribes, puedes utilizar vista previa local para comprobar el documento resultante.
Publicar un módulo de documentación nuevo
Una vez configurado el repositorio y añadido el contenido inicial, está listo para publicarse.
Los módulos de documentación publicados en docs.fp-o están todos listados en libreta Antora principal.
Para añadir un módulo de documentación nuevo, necesitará añadir su repositorio a la lista content.sources:
content:
sources:
- url: https://gitlab.com/path/to/new/repository.git
branches: main (1)
start_path: docs (2)
| 1 | La rama por defecto es master. Si su repositorio utiliza cualquier otro nombre (main por instancia), debe especificarlo aquí. <.> Este ajuste es opcional. Si los ficheros de documentación están almacenados en un subdirectorio de su repositorio (/docs/ por instancia), debe establecer su ruta relativa aquí, sin barras iniciales ni finales. Si se encuentra en el nivel raíz, como se documenta en esta página, puede omitir este parámetro. |
Puede crear una Solicitud de Fusión con estos cambios, o si no se siente cómodo editando este archivo, cree un vale en Repositorio de sitio Web de Docs de Fedora y el Equipo de Documentación se encargará de esa parte por usted.
|
Si no obtiene ninguna actualización de tu Solicitud de Unión o vale después de 5 días, ponte en contacto con el Equipo de Docs. |
Want to help? Learn how to contribute to Fedora Docs ›