Como utilizar el IU GitLab para más mantenimiento de documentos relacionados
La documentación necesita mantenerse como el contenido crece. Los escritores y revisores pueden contribuir a los Docs fácilmente y eficientemente dentro del Interfaz de Usuario Web de GitLab. Desde el IGU Web, conducto CI para colaborar revisiones de contenido web analizado y aprobación de páginas, puede trabajar en buen contenido y mantenimiento de documento, ininterrumpido por instalación y configuración. El artículo asume que ya es familiar con Git y la integración continua (CI/IC).
Mantenimiento de documento
Mantenimiento de documentación toma muchos formatos.
-
Certeza técnica
-
Sin fecha actual
-
Corrección de documentación en un orden lógico
-
Consistencia en presentación
-
Plantilla estándar, atributos y convenciones aplicadas a través de repositorios Docs
-
Utilice un conducto CI para automatizar comprobaciones de calidad de documentos
El siguiente paso de secciones a través de como mantener y mejorar continuamente la calidad de los repos de Fedora Docs utilizando herramientas integradas en GitLab.
IDE de la web GitLab
Lanzado como parte de la publicación de GitLab 15.7 en diciembre de 2022, el IDE Web nuevo proporciona un explorador de archivo, un editor de texto y control de fuente en un lugar.
Explorador
El explorador en el panel izquierdo le ayuda a descubrir la estructura del repositorio y el listado de archivo en Fedora Docs. Cualquier repositorio, la estructura del repositorio estándar permite a los contribuidores navegar rápidamente archivos y múltiples referencias cruzadas de páginas.
Editor de texto
Después de realizar los cambios, vaya al icono de Control de código fuente en la Barra de actividades y haga clic en Cambios debajo del botón Confirmar y enviar para ver una lista de los archivos modificados en vista en paralelo. Si realizó varias confirmaciones, Cambios muestra un resumen de los cambios realizados.
Si hace clic en Crear MR, se le redirigirá a su bifurcación para crear una solicitud de fusión. La opción Ir al proyecto es útil cuando realizó pequeñas confirmaciones por etapa y desea comprimirlas en una sola.
Conducto CI
La prueba automatizada para Docs activa la validación de sintaxis y detecta errores de estilo, y ayuda a corregirlos antes de la fusión de MR. Los objetivos son la coherencia de la documentación en todo el proyecto y el cumplimiento de las guías de estilo. El equipo de Docs introdujo un analizador de documentación con reconocimiento de sintaxis en algunos repositorios donde se pueden encontrar los archivos de configuración de Vale. Algunos colaboradores escriben artículos sin conocimientos de guías de estilo ni de legibilidad. Consulte la configuración del analizador de Vale para CI en los repositorios correspondientes:
El enlazador de documentación realiza más de 20 pruebas:
-
Para activar una canalización de CI para analizar cualquiera de los errores.
-
Para depurar las palabras y la estructura de la documentación.
-
Para comprobar la validez de enlaces.
-
Para comprobar la legibilidad y ejecución de pruebas para idioma consciente y más.
Tenga en cuenta que algodones le ayuda a escribir mejor, pero no corrige automáticamente los errores.
Revisiones visuales
Con las apps revisadas, se exhibe una vista previa viva de página analizada su pulsa el icono ver app o ver despliegue en el anterior MR_number.
Se te mostrará la página de compilación de Artefactos con el número de trabajo y un enlace a la página renderizada alojada en GitLab. Haz clic en el enlace para inspeccionar el contenido, tal como lo hacías al ejecutar el script de Docsbuild en tu computadora local.
La vista previa de los cambios durante la revisión de MR facilita una colaboración estrecha para detectar errores y hacer sugerencias para mejorar el contenido.
El botón Ver aplicación desaparece después de fusionar MR.
Informe de calidad del código
Para ver el resultado del análisis de CI, vaya a Conductos en el panel izquierdo y pulse en calidad del código.
El equipo de documentación evaluará las opciones para reflejar los cambios sistemáticamente según el informe de calidad del código.
Gracias por su contribución.
Want to help? Learn how to contribute to Fedora Docs ›