-
Notifications
You must be signed in to change notification settings - Fork 82
NGF: Add Deploy data plane doc #530
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
base: ngf-feature-cp-dp-split
Are you sure you want to change the base?
NGF: Add Deploy data plane doc #530
Conversation
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.
Generally LGTM, but I have a lot of edit suggestions.
Shell examples are inconsistent: the start of the document delineates the shell command and the output into different code blocks, while later the command and output are put into the same blocks.
In the former case, a reader can easily copy the command - in the latter case, they cannot, and if they go to manually copy the command, they'll be forced to also strip away the shell prompts and other decorations.
I favour the former for general UX, but you can also just block the shell block and the text output together: no need to add text like "You should see these conditions".
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, pending the update to the label issue if we can fix that.
FYI, comment only: we have a definition for |
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.
small formatting edits and questions but lgtm
Proposed changes
Add "Deploy Data plane document" to guide users on how to create and modify the NGINX Data Plane.
Problem: Users want a guide on how to create and modify the NGINX Data Plane.
Solution: Added the guide.
Testing: Tested with
make watch
Closes nginx/nginx-gateway-fabric#3237
Checklist
Before merging a pull request, run through this checklist and mark each as complete.
README.md
andCHANGELOG.md
Footnotes
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. ↩