Documentation as Code con Gitlab y Hugo
2020-12-05, 12:00–12:50, 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