Contribuir a Quick Docs

Sus características son

Sus características son

Si su publicación no cabe en ninguna categoría, considere un artículo bajo Administration Tools o en la página Home. El mejor lugar para preguntar es discussion.fedoraproject.org #docs.

La mejor oportunidad para contribuir surge al leer el artículo en sí. Si encuentras un error, una omisión o una redacción poco clara, puedes contribuir con una mejora. En el encabezado de cada artículo encontrarás enlaces a dos de las tres herramientas para contribuir.

El botón más a la derecha conduce a un sistema de tickets donde puedes señalar el problema.

El campo de asunto ya contiene un enlace al documento afectado. No lo modifique. Por favor, describa la incidencia y, si es posible, sugiera una modificación concisa, preferiblemente lista para copiar y pegar.

Si no ha iniciado sesión en pagure, primero se abrirá una ventana de inicio de sesión de FAS.

El segundo enlace abre un editor web que puedes utilizar para introducir las modificaciones propuestas directamente en el texto.

Los siguientes pasos son explicados en detalle en el artículo How to edit files on the Pagure Web UI.

Puede encontrar y contribuir a cambios necesarios siguiendo el Quick Docs Issue Board, donde los usuarios comparten errores en la documentación o sugerencias para mejorarla.

Si encuentra una incidencia que coincida con su interés y experiencia, en asignar en el cesionario en la parte superior derecha, presione el enlace tomar para asignar una incidencia para sí mismo.

En cualquier caso, el flujo de trabajo sigue el modelo de "pull request" o "merge request". Los cambios no se realizan en el texto publicado, sino en una versión secundaria. Una vez finalizado el trabajo, se activa una "merge request". Los miembros de la comunidad revisarán los cambios e iniciarán un debate o los aceptarán. Posteriormente, se fusionarán en la versión publicada. Por lo tanto, seguimos el principio de los cuatro ojos.

Pull Requests promueve trabajo colaborativo entre escritores y revisores donde los comentarios PR, ediciones y subidas sirven como proceso de revisión.

Los pasos individuales son en gran medida automáticos. Los detalles se describen en las herramientas correspondientes.

Probablemente quieras seguir el progreso después del PR. Para eso está la función "Observar".

Vigila estado en medio de informe de Quick Doc tiene cuatro opciones. Seleccione una de las opciones a continuación.

La notificación irá a su correo-e como en los parámetros del usuario de Pagure.

Si no oyó desde revisiones tras su PR más largo que una semana, deje un comentario en PR para seguimiento.

En lugar de criticar la coherencia del tono y los errores gramaticales, los revisores alientan a los escritores a leer The docs style guide. Si desea pruebas automatizadas, ejecuta enlazador Vale localmente Check Your Documentation Using Vale.

Más allá de la guía de estilo, aquí están unos conjuntos de reglas escasas necesarias a observar.