-
Notifications
You must be signed in to change notification settings - Fork 253
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.
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
Generate reference documentation automatically from godocs in the API #1694
Comments
/help |
@mdbooth: GuidelinesPlease ensure that the issue body includes answers to the following questions:
For more details on the requirements of such an issue, please see here and ensure that they are met. If this request no longer meets these requirements, the label can be removed In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Since CAPO was created as a kubebuilder project, I think this should be useful to us: https://book-v1.book.kubebuilder.io/beyond_basics/generating_documentation |
This looks ideal, but I can't see any reference to it in the v2 docs at first glance. |
Hi! I think that you might use ahmetb/gen-crd-api-reference-docs. It's used in many well-known projects and I use it in a personal project, it works like a charm. For instance: https://github.com/alexandrevilain/temporal-operator/blob/main/docs/api/v1beta1.md |
That looks good! |
I created a PR using ahmetb/gen-crd-api-reference-docs. I hope it can help. |
/kind feature
We should automatically generate user-referenceable documentation for our APIs from the APIs themselves. We should publish them in/with the CAPO book.
Whether the documentation is generated directly from the API or indirectly via the CRDs is not important. We should investigate how this is solved in other projects to determine existing best practise.
The text was updated successfully, but these errors were encountered: