Kubernetes SIG Docs: A Deep Dive
Talkat KubeCon + CloudNativeCon North America 2021 · on Wednesday, 2021-10-13· at 17:25· Concourse Hall 150 ABC + Online·
summary
Kubernetes documentation is stored as markdown and generated by Hugo + Doxy theme, published by Netlify preview builds that run the hugo command and flip traffic only after a successful build; the site serves about 1.3 million monthly users and rebuilds hundreds of times per day. Content uses Hugo shortcodes and config.toml-driven values to update versions in one place, PRs trigger Prow checks and CLA validation, PR wranglers triage submissions, and localization teams maintain translations (China, Hindi, Punjabi) with mermaid for inline diagrams.
AI-written summary · about
chapters (23)
- 0:00Intro
- 1:44Source control
- 2:01Markdown
- 6:41Hugo Shortcodes
- 8:49Hugo Theme(s)
- 9:06Hugo theme for templating
- 11:12Key Points
- 13:41Why contribute to SIG Docs?
- 14:24Where do I go from here?
- 16:38Opening a PR using GitHub
- 17:11Working from a local fork
- 17:53Opening a PR from your fork
- 18:31Code review automation
- 19:26Automatic preview
- 21:12Local preview
- 21:29Contribution
- 21:55Style
- 22:31Writing great docs
- 23:52Great docs can include diagrams Diagrams improve documentation clarity and comprehension. Use Mermaid to generate diagrams
- 26:27Pull request wrangler
- 27:35Localization
- 30:56Recap
- 31:34Next steps
related talks
01h 04mIntro + Deep Dive: Kubernetes (Docs) SIG
26mIntro to Kubernetes Docs
26mGetting Involved in Kubernetes SIG Docs and Korean Localization
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
26mWhat you get when you invest Non-Docs time in Docs tools
59mTransforming your Documentation Process
50mContent as code, technical writers as developers
36mBuilding Docs like Code: Continuous Integration for Documentation