-
Notifications
You must be signed in to change notification settings - Fork 66
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationkind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.v1.0Issues related to the initial stable release of OLMv1Issues related to the initial stable release of OLMv1
Milestone
Description
Write OperatorController 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/)
- ClusterExtension API reference documentation
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 #740
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationkind/documentationCategorizes issue or PR as related to documentation.Categorizes issue or PR as related to documentation.v1.0Issues related to the initial stable release of OLMv1Issues related to the initial stable release of OLMv1
Type
Projects
Status
Done