The Kubernetes project has one of the best documentation in the industry, and it’s a major reason for the project’s success. Writing and maintaining that documentation requires the support of a small army of contributors, but there’s an often unseen part of the documentation workflow that still needs attention: the API reference docs generator.
During this LFX Fall mentorship, SIG DOCS improved the reference docs generator by documenting the code, adding error handling, removing deprecated functions, fixing bugs that affected every release cycle, and simplifying the steps required to generate API reference docs.
But SIG Docs still needs your help. Especially around configuring and automating the workflow to make API reference generation even smoother. This session explains how automating the config.yaml file makes the process easier, what future improvements are planned, and how you can get involved in ensuring Kubernetes documentation continues to be the best it can be.