solr-operator icon indicating copy to clipboard operation
solr-operator copied to clipboard

Better documentation of each CRD and it's options

Open HoustonPutman opened this issue 5 years ago • 0 comments

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 avatar Feb 20 '20 20:02 HoustonPutman