Language: Spanish
2020-12-05, 12:00–12:50 (America/Mexico_City), Stream 4
Documentation as Code o Doc as Code o Documentación como Código es una filosofía que nos dice que deberíamos escribir documentación de la misma manera en que escribimos código:
- A través de
issues
- Usando control de versiones (
Git
) - Archivos en texto plano (
Markdown
) - Mediante colaboración y revisiones de código
- Implementando pruebas automatizadas
Doc as Code habilita una cultura donde escritores y desarrolladores son los propietarios de la documentación y donde colaboran juntos para hacerlo lo mejor posible.
En este demo se mostrará de manera muy básica cómo implementar Doc as Code desde cero y sus ventajas.
Utilizando gitlab-ci
crearemos un pipeline que ejecute las siguientes tareas de manera automatizada:
- Revisión de estilo
- Validación de links e imágenes
- Ortografía
- Generación de código estático con
Hugo
- Despliegue de código en
gitlab-pages
Enrique Cuevas o rastangineer es un Ingeniero en Computación con 15 años de experiencia en el área de IT. Especializado en DevOps, Cloud Architecture, Agile y Mejora Continua, se la pasa siempre aprendiendo sobre Linux, leyendo libros de IT y HackerNews. Ha colaborado directamente con compañías como Hewlet-Packard, DXC Technology y Oracle en diversas áreas como midleware, soporte, operaciones y la nube, siempre promoviendo una cultura abierta dentro de las organizaciones.