Skip to content

Docs: Catalogd API reference #1125

@perdasilva

Description

@perdasilva

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/)

  • ClusterCatalog 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 operator-framework/catalogd#239

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationkind/documentationCategorizes issue or PR as related to documentation.v1.0Issues related to the initial stable release of OLMv1

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions