planetscale/vitess-operator

Vitess Operator API Reference is stale

yoheimuta opened this issue · 0 comments

README.md has a link to the documentation about CRD APIs implemented by the operator.

- [VitessCluster CRD API Reference](docs/api.md)

But the last time when this API document was updated was Aug 31, 2021.
So, it lacks a lot of recent information.

As CONTRIBUTING.md mentions the user-facing docs for the public API, wouldn't it be useful for OSS users to hook up with https://vitess-operator.planetscale.dev/api/ instead of the out-of-date markdown file?

### CRD API Documentation
It may help to start by reading the user-facing docs for the public API,
which can be found in `docs/api` or published at:
https://vitess-operator.planetscale.dev/api/