Skip to content

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

Open
wants to merge 5 commits into
base: ngf-feature-cp-dp-split
Choose a base branch
from

Conversation

bjee19
Copy link

@bjee19 bjee19 commented May 6, 2025

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.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. 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.

@bjee19 bjee19 requested a review from a team as a code owner May 6, 2025 23:08
@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels May 6, 2025
@bjee19 bjee19 requested a review from a team May 6, 2025 23:08
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a 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".

Copy link
Contributor

@sjberman sjberman left a 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.

@mjang
Copy link
Contributor

mjang commented May 8, 2025

FYI, comment only: we have a definition for Data plane in our N1C glossary: https://docs.nginx.com/nginx-one/glossary/

Copy link

@salonichf5 salonichf5 left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants