Kubernetes SIG Docs: A Deep Dive


Authors:   Brad Topol, Chris Metz, Jim Angel


The presentation discusses the process of creating and maintaining the Kubernetes website using Hugo and Netlify.
  • The Kubernetes website is generated using Hugo, which converts markdown files into HTML pages.
  • Shortcodes are used to dynamically generate content based on data in the config.toml file.
  • The website uses the Doxy theme, which is a submodule maintained separately from the main repository.
  • Netlify is used to host the website and has a similar configuration file structure to Hugo.
  • Netlify allows for easy deployment and testing of changes to the website.
  • The use of Hugo, shortcodes, and Netlify allows for efficient and dynamic management of the Kubernetes website.
The speaker shares their experience of realizing the importance of documentation in their previous job, where there was often no documentation available for new software. This led them to become a member of the Kubernetes documentation team and learn about the process of creating and maintaining the website.


This session covers Kubernetes (K8s) documentation. We'll do an overview of the docs--how they're organized, and how they're maintained--then contribute to the docs ourselves. During the introduction, we'll look at the docs repository (kubernetes/website) and how we organize content. We'll also look at the website stack: how we preview and publish docs to kubernetes.io. We'll talk about the docs workflow: how SIG Docs does the work to review and publish docs. During the deep dive, we'll explore the docs contributor guide and do some hands-on contribution. Remember that contributing to docs is a pathway to Kubernetes membership!


Post a comment

Related work

Authors: Tim Bannister, Arsh Sharma, Rey Lejano, Divya Mohan, Natali Vlatko

Authors: Kunal Kushwaha, Kaslin Fields, Chris Short, Bart Farrell, Matt Broberg

Authors: Carolyn Van Slyck, Josh Berkus