Update NGF documentation on how to use NginxProxy #132
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
…#117) This commit adds the NGINX Gateway Fabric team as codeowners of the NGF subfolders related to the product, ensuring they get tagged when relevant. As part of this change, I have also alphabetized the teams and adjusting the spacing for readability. Co-authored-by: Jodie Putrino <jputrino@users.noreply.github.com>
* add staged config one.json changes * Apply suggestions from code review --------- Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com>
Updates the Gateway API Compatibility doc to list Gateway Infrastructure field as partially supported. Also, updates the data plane configuration how-to to describe how to attach NginxProxy resources to Gateways and GatewayClasses.
kate-osborn
force-pushed
the
more-nginx-proxy-changes
branch
from
643e95e to
1f0eb56
Compare
|
@kate-osborn Did you branch this from |
oops, I did not. I'll fix |
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: The documentation for NGF's NginxProxy API needs to be updated now that NGF supports attaching NginxProxy resources to Gateways.
Solution: Updates the Gateway API Compatibility doc to list Gateway Infrastructure field as partially supported. Also, updates the data plane configuration how-to to describe how to attach NginxProxy resources to Gateways and GatewayClasses.
Testing: Checked the rendered documentation.
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.mdandCHANGELOG.md)Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation.
Please refer to our style guide for guidance about placeholder content.