Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vitess Operator API Reference is stale #354

Open
yoheimuta opened this issue Jan 5, 2023 · 0 comments
Open

Vitess Operator API Reference is stale #354

yoheimuta opened this issue Jan 5, 2023 · 0 comments

Comments

@yoheimuta
Copy link
Contributor

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant