planetscale / vitess-operator

Kubernetes Operator for Vitess
Apache License 2.0
305 stars 75 forks source link

Update `docs/api.md` and automatically update it #612

Closed frouioui closed 1 month ago

frouioui commented 1 month ago

Each time we change the CRDs we do update part of our documentation in ./docs/api/index.html, but this document is hardly readable for anyone and does not render well on the GitHub UI either. The better way of showing this documentation is by just changing the file extension to Markdown and GitHub will know how to render it. We do have the Markdown version of ./docs/api/index.html, which is located in ./docs/api.md. However, we have not updated this file in several years despite the many changes to vitess-operator.

This is an issue as ./docs/api.md is supposed to be the only very-up-to-date documentation we have for vitess-operator.

This PR fixes this issue by adding a phase to make generate that will copy the newly generated ./docs/api/index.html into ./docs/api.md and remove the first two line of the file (which contain HTML headers that do not render well in Markdown).

Adding this as part of make generate will ensure that the documentation will always be consistent as we have a CI checks that makes sure make generate has been run on any new commit.

stankevich commented 4 weeks ago

I believe this closes https://github.com/planetscale/vitess-operator/issues/354. Cross-linking https://github.com/planetscale/vitess-operator/issues/288 and https://github.com/planetscale/vitess-operator/issues/3 for completeness.