SIG Docs and You: Modernizing API Reference Generation - Kat Cosgrove & Xander Grzywinski
Kat Cosgrove, Xander Grzywinski
KubeCon + CloudNativeCon Europe 2025 · Session
This talk, presented by SIG Docs Technical Leads Kat Cosgrove and Xander Grzywinski at KubeCon EU, delves into the critical but often overlooked process of generating API reference documentation for Kubernetes and kubectl. Far from a triumphant showcase of innovation, the presentation served as a candid and urgent "cry for help," exposing a deeply problematic and unsustainable system that has become a significant source of technical debt for the Kubernetes project. The speakers meticulously outlined the current, highly manual, and error-prone workflow for creating these essential reference materials, highlighting its numerous points of failure, lack of documentation, and reliance on a select few individuals with esoteric knowledge.
AI review
This talk by SIG Docs leads Kat Cosgrove and Xander Grzywinski was a brutally honest exposé of the critically broken and unsustainable process for generating Kubernetes and kubectl API reference documentation. Far from a polished demo, it was a detailed "cry for help," revealing a convoluted "rat king" of undocumented scripts, manual interventions, and single points of failure that severely hinder contributor onboarding and threaten the project's long-term health. The speakers meticulously detailed the technical debt and operational hurdles, providing a clear call to action for the community…