Treating Documentation like Code: a Practical Account
summary
Project puts docs in the code repo and uses Sphinx (Python projects) with Read the Docs early then moves builds to AWS S3 for security. CI runs in a Docker container via Travis CI/GitLab CI, executing make html, make linkcheck and writegood so doc tests break the build. Deploys from a release branch to S3 for continuous delivery. Multiple repositories publish to one hosted site (clouddocs.f5.com) and versioning separates product and solution docs.
AI-written summary · about
chapters (4)
- 0:00Start
- 0:01Treating Documentation like Code: A Practical Account Jodie Putrino
- 1:46We want to develop the documentation with the code.
- 20:28The process is not the thing. It's always worth asking, do we own the process or does the process own us?
related talks
35mBuilding Docs like Code: Continuous Integration for Documentation
36mBuilding Docs like Code: Continuous Integration for Documentation
25mBuilding Docs like Code: Continuous Integration for Documentation
19mWhere Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect
42mEngineering Documentation
45mDocs as Code Fix a poor documentation culture in your organization
44mPushing documentation (so it doesn't hurt anymore)
33mWrite the Docs!