Saltar al contenido

Construir o contribuir a la documentación con un flujo de trabajo basado en Git

Descripción

La documentación de las aplicaciones y paquetes de software suele ser una idea tardía en el mejor de los casos, y con frecuencia se olvida por completo. Reunir una buena documentación de fácil navegación que pueda ser actualizada por la comunidad de manera controlada puede ayudar realmente a evitar preguntas y hacer que su aplicación o paquete sea más fácil de usar. En este curso, Construye o contribuye a la documentación con un flujo de trabajo basado en Git, explorarás un par de opciones disponibles para ti, y luego entrarás en una solución completa usando Read the Docs creando un proyecto de documentación. En primer lugar, aprenderás sobre la sintaxis de reStructuredText para algunos de los elementos clave que probablemente quieras incluir en tu documentación. Luego, te sumergirás en la creación de un flujo de trabajo CI/CD poniendo tu documentación en GitHub y mostrarás el flujo de trabajo estándar para las solicitudes de extracción. Además, descubrirás cómo personalizar el aspecto de tu documentación, usar Markdown y tener diferentes versiones de tu documentación. Finalmente, explorarás la documentación y el código de autoalojamiento en caso de que un sitio alojado en Read the Docs no sea una buena opción para ti. Al final de este curso, tendrás el conocimiento necesario para crear eficientemente tus propios proyectos de documentación, contribuir a la documentación de código abierto, hacer peticiones de pull y conocer las opciones de alojamiento disponibles.

Construir o contribuir a la documentación con un flujo de trabajo basado en Git
Construir o contribuir a la documentación con un flujo de trabajo basado en Git