Generate API docs #1884
Merged
Generate API docs #1884
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
|
@nginxinc/nginx-docs I need your help to make the new page look good 😅 |
ciarams87
reviewed
Apr 26, 2024
|
@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. |
jputrino
previously requested changes
May 15, 2024
|
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. |
sjberman
reviewed
Jun 6, 2024
|
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
lucacome
requested review from
sjberman,
kate-osborn,
ADubhlaoich and
danielledeleo
sjberman
reviewed
Jun 10, 2024
Co-authored-by: Saylor Berman <s.berman@f5.com>
sjberman
approved these changes
Jun 10, 2024
pleshakov
reviewed
Jun 10, 2024
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Problem: We want to have our CRDs documented Solution: Use gen-crd-api-reference-docs to generate the docs automatically Co-authored-by: Danielle De Leo <d.deleo@f5.com> Co-authored-by: Saylor Berman <s.berman@f5.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.