Intro to Kubernetes Docs
Talkat KubeCon + CloudNativeCon North America 2020 Virtual · on Thursday, 2020-11-19· at 17:40· Intrado Virtual Event Platform,·
summary
Kubernetes docs live in the website repo (k8s.io) as markdown rendered by Hugo with a customized doxy theme; source lives on GitHub, CI uses Prow + Netlify for preview builds and continuous deploy to master. Contributors run make container-image and make container-serve to test locally at localhost:1313. The project supports 13 localized languages, requires a CLA, uses labels like lgtm and approved for merge, and treats small edits (spelling, grammar) and full pages equally.
AI-written summary · about
chapters (23)
- 0:00Intro
- 0:19SIG Docs
- 0:54Website: Concepts
- 1:08Website: Tasks
- 1:48Community
- 2:28Source control
- 2:45Markdown
- 3:14Where to Start
- 4:09Contributor License Agreement
- 5:20Templating
- 5:54Code review automation
- 6:30Automatic preview
- 7:34Continuous deployment
- 10:20Local preview
- 11:30Contribution
- 12:21Style
- 13:19Getting going
- 14:10Writing great docs
- 17:29Pull request wrangler
- 18:34Localization
- 23:08Recap
- 23:56Next steps
- 24:18Get in touch
related talks
32mKubernetes SIG Docs: A Deep Dive
01h 04mIntro + Deep Dive: Kubernetes (Docs) SIG
26mGetting Involved in Kubernetes SIG Docs and Korean Localization
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
39mWhat's in a Word? Lessons from Localizing Kubernetes Documentation to Arabic
36mBuilding Docs like Code: Continuous Integration for Documentation
25mBuilding Docs like Code: Continuous Integration for Documentation
29mMaking Tech Documentation Better, Easier, And Less Boring
