Contribuir a Quick Docs

El Equipo de Documentación de Fedora. Version all versions Last review: 2023-08-25
El objetivo es alejarse de los wikis, donde se mezclan guías útiles con documentación en borrador y notas internas, hacia guías prácticas agradables y orientadas a los temas y tutoriales llenos de código con un flujo de trabajo basado en solicitudes de extracción. ¡Agradecemos su ayuda!

Pasos

  1. Elija un documento para actualizar. Puede encontrar documentos que necesitan actualización en el archivo modules/ROOT/nav.adoc. Están en las líneas comentadas (aquellas que empiezan con //FIXME).

  2. Bifurque el repositorio https://pagure.io/fedora-docs/quick-docs.

  3. Haga sus cambios en el archivo ..adoc que desee mejorar.

  4. Quite el comentario al archivo en nav.adoc eliminando el FIXME desde el xref.

  5. Cree una vista previa local para asegurarse de que sus cambios se ven como esperaba: Compruebe que tiene instalado Podman o Docker. En un escritorio Linux ejecutando ./docsbuilder.sh. En macOS ejecutando ./docsbuilder.sh -p o ./preview.sh. Siga las instrucciones impresas en la línea de comandos.

  6. Cuando esté satisfecho con sus actualizaciones, envíe una petición de extracción con sus mejoras.

  7. Si está migrando una página wiki, cree una redirección en la página antigua — vea abajo.

Posible Material Fuente

Quizás solo quiera mejorar un documento existente, en cuyo caso todo lo que necesita es lo de arriba. O puede ser que ya tenga algo en mente. Pero si esta interesado en ayudar y no sabe dónde empezar, aquí hay algunos sitios para buscar ideas:

  • La antigua Categoría Como en la wiki Fedora. Muchos de estos documentos están listos para la conversión. (¡Muchos también están muy desactualizados!)

  • Las preguntas de Problemas Comunes en Ask Fedora.

  • Las preguntas frecuentes de Fedora en Stack Exchange.

  • Los artículos en Fedora Magazine. El formato de la revista es conversacional y se entiende que representa un momento en el tiempo. Las versiones de Quick Docs deberían ser más concretas y mantenerse actualizadas si cambian los comandos o las mejores prácticas.

Redirecciones Wiki

Normalmente. Las wikis no permiten redirecciones a sitios externos, porque el potencial de abuso es muy alto. Hemos desarrollado un complemento para Fedora Wiki que permite redirigir solo a páginas en este sitio, https://docs.fedoraproject.org/. Para crear dicho enlace, use la macro #fedoradocs poniendo algo como esto en la parte superior de la página wiki que está reemplazando:

{{#fedoradocs: https://docs.fedoraproject.org/en-US/council/fpl/}}

Desde luego, debe reemplazar la URL del ejemplo con su nueva página objetivo. De nuevo, la URL no puede ser algo arbitrario y debe empezar con https://docs.fedoraproject.org/.

Una vez la redirección está en su sitio, los visitantes de esta página wiki serán redirigidos instantáneamente (bien, redirigidos, con el código 301 Moved Permanently) al sitio de documentos.

Tenga en cuenta que no hay validación de que el objetivo exista o sea correcto — haga doble comprobación de que cualquier redirección que cree trabaja apropiadamente antes de moverlo.

Si necesita editar dicha página para corregir la URL o para eliminar la redirección por cualquier motivo, cree una URL de sitio wiki con`&action=edit`, como:

https://fedoraproject.org/w/index.php?title=Project_Leader&action=edit

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