Restructure, reformat and rewrite API Compatibility Documentation #1337
Conversation
This file contains 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
Change docs structure and add the required files to build documentation Hugo and publish with Netlify Rewrite existing docs to work with Hugo --------- Co-authored-by: Travis Martin <t.martin@f5.com> Co-authored-by: Travis Martin <33876974+travisamartin@users.noreply.github.com> Co-authored-by: Kate Osborn <50597707+kate-osborn@users.noreply.github.com> Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com> Co-authored-by: Alan Dooley <a.dooley@f5.com>
Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible. Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.
…ginxinc#1296) This commit updates the control plane configuration documentation to match NGINX's standardised Hugo formatting conventions: specifically, avoiding breaking sentences across line and the use of shortcodes for a note. There are also some minor content changes for product noun conventions and rephrasing a few sentences. --------- Co-authored-by: Jon Torre <78599298+Jcahilltorre@users.noreply.github.com>
* docs: update architecture doc * chore: update architecture description --------- Co-authored-by: Alan Dooley <ADubhlaoich@users.noreply.github.com>
This commit makes a few changes to increase readability: - The table format from the summary is re-used for individual resources - The order of resources is changed to match the API specification - Capilisation and other style concerns have been standardised - Text has been rewritten for conciseness where possible I considered linking to the API specification sections to match the resources, but I noticed that they were versioned, which could possibly create issues for us in managing drift.
✅ Deploy Preview for nginx-gateway-fabric ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
github-actions
bot
added
the
documentation
ADubhlaoich
force-pushed
the
docs/api-compatibility-review
branch
from
b7142df
to
60b478d
Compare
Jcahilltorre
approved these changes
Dec 5, 2023
kate-osborn
reviewed
Dec 5, 2023
ADubhlaoich
commented
Dec 6, 2023
kate-osborn
approved these changes
Dec 6, 2023
ciarams87
approved these changes
Dec 7, 2023
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
This commit makes a few changes to increase readability:
I considered linking to the API specification sections to match the resources, but I noticed that they were versioned, which could possibly create issues for us in managing drift.
Checklist
Before creating a PR, run through this checklist and mark each as complete.