Extend resource validation doc to include NGINX Gateway Fabric resources #1399
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
github-actions
bot
added
the
documentation
sjberman
approved these changes
Dec 15, 2023
bjee19
approved these changes
Dec 15, 2023
pleshakov
approved these changes
Dec 16, 2023
kate-osborn
force-pushed
the
docs/add-nkg-crd-to-resource-validation
branch
from
84d32d4
to
4a7d2ff
Compare
travisamartin
approved these changes
Dec 19, 2023
Co-authored-by: Michael Pleshakov <pleshakov@users.noreply.github.com>
kate-osborn
force-pushed
the
docs/add-nkg-crd-to-resource-validation
branch
from
4a7d2ff
to
8b9e424
Compare
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 resource validation doc does not include any information on how we validate NGINX Gateway Fabric resources.
Solution: Add a section on NGINX Gateway Fabric resources to the resource validation doc.
Please focus on (optional): Even though we only have one CRD with a single field right now, I tried to make the information generic so we don't have to modify it too much in the future.
Closes #970
Checklist
Before creating a PR, run through this checklist and mark each as complete.