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.

Sign up for GitHub

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

Jump to bottom

Docs: Operator-Controller API reference #1126

Closed
1 task
perdasilva opened this issue Aug 14, 2024 · 0 comments · Fixed by #1230
Closed
1 task

Docs: Operator-Controller API reference #1126

perdasilva opened this issue Aug 14, 2024 · 0 comments · Fixed by #1230
Assignees
@dtfranz
Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Milestone
v1.0.0

Comments

@perdasilva
Copy link
Contributor

perdasilva commented Aug 14, 2024 •
edited
Loading

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
@perdasilva perdasilva mentioned this issue Aug 14, 2024
Closed
14 tasks
@perdasilva perdasilva added documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. labels Aug 14, 2024
@perdasilva perdasilva changed the title Operator-Controller API reference Docs: Reference: Operator-Controller API reference Aug 14, 2024
@perdasilva perdasilva changed the title Docs: Reference: Operator-Controller API reference Docs: Operator-Controller API reference Aug 14, 2024
@everettraven everettraven added this to the v1.0.0 milestone Aug 20, 2024
@everettraven everettraven added the v1.0 Issues related to the initial stable release of OLMv1 label Aug 27, 2024
@dtfranz dtfranz mentioned this issue Sep 6, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dtfranz dtfranz

Labels
documentation Improvements or additions to documentation kind/documentation Categorizes issue or PR as related to documentation. v1.0 Issues related to the initial stable release of OLMv1
Projects
OLM v1
Archived in project
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

📖 [Docs] API Reference Doc Generation dtfranz/operator-controller
3 participants
@perdasilva @dtfranz @everettraven