A Practical Introduction to Docs-As-Code
summary
Practical demo converts a Word doc to reStructuredText with Pandoc inside Docker, adds images, and builds a static site with Sphinx + reStructuredText and Make. CI runs on commit: spellcheck, linkcheck and linting run in parallel jobs and fail the pipeline until fixed; merges trigger a GitLab Pages deploy. Docker images are built and pushed to the GitLab registry with caching to save minutes. Useful checklist and working repo show the full pipeline: GitLab CI with Docker image registry.
AI-written summary · about
chapters (9)
- 0:00Start
- 1:17Who is Alec?
- 3:16What is practical "Docs As Code"
- 4:44Expectations, truths and Myths ...
- 5:38What you need
- 8:21Note Familiar with Docker?
- 9:13Linters for human language
- 10:25Can't change your authoring tools?
- 11:01Solution Components
related talks
36mBuilding Docs like Code: Continuous Integration for Documentation
45mDocs as Code Fix a poor documentation culture in your organization
35mBuilding Docs like Code: Continuous Integration for Documentation
23mTreating Documentation like Code: a Practical Account
27mPractical Sphinx
35mThe practical implementation of Documentation as Code
01h 06mDocument your code
42mEngineering Documentation