You know how some Kubernetes CRDs have no documentation and incomplete examples, so you have to wade through the CRD to figure how how to configure it? You might think that is simple laziness on the part of the developers, but you’re wrong. It’s abject laziness. It’s pathological laziness. It’s malicious laziness. It is the deadly sin of sloth.
If you’ve already written the CRD, you can generate documentation for free!
If you are currently trying to use a CRD that doesn’t provide complete documentation, you can generate some right away with https://doc.crds.dev/. Just pop in the GitHub repo and it’ll find them for you! Amazing.
If you’re writing CRDs, for god’s sake at least link to this in your readme, if you can’t bother to generate them yourself with one of the many programs designed for this purpose.