DevOps Your Docs
summary
Requires text-based markup, Git for version history, and a tiny initial config committed to the repo; run the same checks locally and in continuous integration so pull requests fail when links, syntax, style or spelling break. Uses link checkers, formatters, prose linter Veil, an OpenAPI linting CLI and GitHub Actions examples; previews for every PR validate builds and visual diffs. Start minimal, test that failures actually fail, then iterate.
AI-written summary · about
chapters (12)
- 0:00DevOps for documentation
- 1:47Docs as code prerequisites
- 4:02Automation in docs as code
- 6:11Tool selection and setup
- 9:04CI checks automation
- 11:32CI configuration example
- 13:01Surprises in docs DevOps
- 17:42Tooling for doc quality
- 23:22Preview builds in PRs
- 25:10Using Vale for quality assurance in documentation
- 28:26Investment and culture shift
- 31:58Q&A
related talks
25mBuilding Docs like Code: Continuous Integration for Documentation
20mJourney Of Devops Teams in a Corporate Environment
55mDevOps isn't just about developing
59mDevOps for the Discouraged
47mTales from the Dev Side: What Went Wrong, What We Fixe & What You Can Steal
31mDevOps 2.0 - Bigger, Badder with More Automation
15mDevOps for Mere Mortals
40mDevOpsDocs: Transforming Tediousness into Joy