Dive into a comprehensive conference talk exploring Kubernetes SIG Docs, presented by Jim Angel from Google, Chris Metz, an independent expert, and Brad Topol from IBM. Gain insights into the organization, maintenance, and contribution process of Kubernetes documentation. Learn about the docs repository structure, website stack, and publishing workflow to kubernetes.io. Explore hands-on contribution techniques, including opening pull requests, working with local forks, and utilizing code review automation. Discover best practices for writing effective documentation, incorporating diagrams using Mermaid, and participating in localization efforts. Understand the pathway to Kubernetes membership through documentation contributions and get equipped with next steps to further engage with the Kubernetes community.
Overview
Syllabus
Intro
Source control
Markdown
Hugo Shortcodes
Hugo Theme(s)
Hugo theme for templating
Key Points
Why contribute to SIG Docs?
Where do I go from here?
Opening a PR using GitHub
Working from a local fork
Opening a PR from your fork
Code review automation
Automatic preview
Local preview
Contribution
Style
Writing great docs
Great docs can include diagrams Diagrams improve documentation clarity and comprehension. Use Mermaid to generate diagrams
Pull request wrangler
Localization
Recap
Next steps
Taught by
CNCF [Cloud Native Computing Foundation]
