search

operator-framework / operator-controller

A new and improved management framework for extending Kubernetes with Operators
https://operator-framework.github.io/operator-controller/
Apache License 2.0
46 stars 52 forks source link

Docs: Catalogd API reference #1125

Closed perdasilva closed 3 days ago

perdasilva commented 1 month ago

Write Catalogd API reference documentation. Sync with @michaelryanpeter to see if there are any tools that can go from godoc to the API reference. Another option might to source the information from the CRD which is in openAPI format. There might already be tools to process that. (See what k8s does here: https://kubernetes.io/docs/contribute/generate-ref-docs/kubernetes-api/)

Current documentation is posted up at https://operator-framework.github.io/operator-controller/ New docs should be placed in docs/drafts

[!NOTE] This documentation should be written after https://github.com/operator-framework/catalogd/issues/239

michaelryanpeter commented 1 week ago

Docs generation tooling for the downstream OpenShift client: https://github.com/openshift/oc/tree/master/tools/gendocs