DocOps: engineering great documentation
summary
Nexmo’s docs platform uses Ruby on Rails and GitHub-flavored Markdown with a 22-stage middleware pipeline that adds tabs, sequence diagrams and screenshot generation, keeping markdown files in directories and caching renders (typical cold render ~40 ms). Contributions are open source with contribution guides and style guides; automation runs Travis CI on external code-example repos to update docs and create PRs. API reference is generated from an OpenAPI 3.0 spec; repo stats: 70 commits 1,500 changes from 22 contributors.
AI-written summary · about
chapters (8)
- 0:00Introduction to DocOps
- 1:04What is DocOps?
- 3:13Engineering documentation contributions
- 5:43Powerful tooling for documentation
- 14:10Contribution guidelines
- 16:15Automating documentation workflows
- 17:39Docs like code approach
- 19:47Summary and closing
related talks
40mThe Rocky Road to DocOps
42mEngineering Documentation
19mStreamlining API Documentation: Proven DocOps Strategies
25mBuilding Docs like Code: Continuous Integration for Documentation
35mBuilding Docs like Code: Continuous Integration for Documentation
35mOpenAPI for Documentarians
05mDocs as Part of the Product: Open Source Technical Documentation at Scale
47mEngineering Documentation