-
Notifications
You must be signed in to change notification settings - Fork 97
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 API docs #1884
Generate API docs #1884
Conversation
9838a02
to
06d6744
Compare
@nginxinc/nginx-docs I need your help to make the new page look good 😅 |
@Jcahilltorre @travisamartin Any thoughts on the formatting issues for this generated API documentation? I think there's some examples without these formatting issues in NGINX Management Suite, which are OpenAPI based IIRC. |
dd7cb3a
to
5916cb9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docs solutions need to be discussed with the docs team before implementation and must align with the NGINX content standards. Please close this PR until it can be brought into alignment with how we publish API documentation for NGINX and F5 products.
a611491
to
97b2501
Compare
The issue with this structure is it's just in alphabetical order. I want to easily be able to delineate between the different policies and their sub-fields. Should be separated by policy. A ToC for each policy would also help. |
0a24c09
to
c61ae14
Compare
c61ae14
to
3e55089
Compare
Turns out there was a missing tag for the types, they're now showing correctly by policy |
Problem: We want to have our CRDs documented Solution: Use gen-crd-api-reference-docs to automatically generate the docs
Co-authored-by: Danielle De Leo <[email protected]>
2968228
to
b25da33
Compare
Co-authored-by: Saylor Berman <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Proposed changes
Problem: We want to have our CRDs documented
Solution: Use gen-crd-api-reference-docs to automatically generate the
docs
Closes #1754
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes
If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.