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

Better documentation of each CRD and it's options #77

Open
HoustonPutman opened this issue Feb 20, 2020 · 0 comments
Open

Better documentation of each CRD and it's options #77

HoustonPutman opened this issue Feb 20, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@HoustonPutman
Copy link
Contributor

HoustonPutman commented Feb 20, 2020

Some CRDs for this operator, especially the SolrCloud CRD, are getting extrememly large. This is because we are importing options from base kubernetes objects, which expand out to be extremely large.

Because these files are much too big to parse, we should have documentation for each CRD, explaining at least the basics of using each one. Eventually we can hopefully start to use links to the other types of resources, so they don't have to be explicitly listed in our CRDs. But for now I think the solution is just to add better documentation.

@HoustonPutman HoustonPutman added the documentation Improvements or additions to documentation label Jan 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant