DevOpsDays Cuba 2016: Ignite - Docs as Code

Author: Genry Leyva González
Summary:
Forma simple de creación de documentación. Documentación como código. Entorno de integración y entrega continua para revisión, pruebas, mezcla. Uso de la misma infraestructura de desarrollo para la documentación. Generación automática de documentos en diferentes formatos. Entrega de documentación junto con el producto.

Transcript

1. Genry Leyva González @genrylg www.linkedin.com/in/genrylg genry.leyva@datys.cu Ops Team at
2. DOCs as Code
3. User’s Manual Install Manual README Administration Manual Contribution Guide API Specification
6.  Poor Collaboration  Lack of versioning  Documentation at the end  Different cadence between release and doc  Developers not involved  Difficult to obtain different file formats
7. DOCs as Code 2007 2008 2009 … 2014 2015 2016 collaboration developers involved review & merge testing & publishing semantic versioning
8. Next In Progress … UAT Pending for Doc Being Documented Doc Ready Staging feature feature feature feature feature feature feature feature feature feature feature feature feature Documentation Stages
9. Next In Progress … Dev Done Pending for Doc Being Documented Doc Ready Staging feature feature feature feature feature feature feature feature feature STEP 1 STEP 2 STEP 3 STEP 4 STEP 5 feature feature feature feature Every feature is documented as part of a delivery process Definition of DONE
10. Create feature branch for a new feature / user story Write new or edit existing documentation Create pull request Automatic Testing Review Merge to the develop branch Regenerate documentation files Merge Trigger of CI plan to publish CREATION PROCESS
11. Branch by feature Git on Gitlab Continuous Integration
12. Semantic Versioning
13. lightweight markup language plain text formatting it can be converted to many formats
14. PANDOC IN: more than 20 OUT: more than 30 CLI
15. Doc Proyects in Gitlab
17.  Simple way of writing documents  Collaboration  Writers have a similar workflow to developer
18.  Based on developers' infrastructure  Ops team as enablers  Documentation delivered along with a product
20. genrylg genrylg DOCs as Code