Skip to content

NGF: Update user architecture guide #953

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

Merged
merged 7 commits into from
Aug 18, 2025

Conversation

salonichf5
Copy link
Contributor

Proposed changes

Updates user architecture guide to be less verbose and more readable with high level overview

  • simplified diagrams
  • descriptions for diagrams are put into tables
  • restructuring some of the content
  • linked Developer guide in the introduction

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@github-actions github-actions bot added documentation Improvements or additions to documentation product/ngf Issues related to NGINX Gateway Fabric labels Aug 13, 2025
@salonichf5 salonichf5 force-pushed the docs/architecture-guide branch 2 times, most recently from 424e4c5 to 7371e09 Compare August 13, 2025 16:09
@salonichf5 salonichf5 changed the base branch from main to ngf-release-2.1 August 13, 2025 16:09
@salonichf5 salonichf5 force-pushed the docs/architecture-guide branch 2 times, most recently from 61807f5 to 6d7564c Compare August 13, 2025 16:12
@salonichf5 salonichf5 marked this pull request as ready for review August 13, 2025 16:41
@salonichf5 salonichf5 requested a review from a team as a code owner August 13, 2025 16:41
@sjberman
Copy link
Contributor

Does this have anything specific to our 2.1 release? If not, it can target main.

@sjberman sjberman requested a review from a team August 13, 2025 16:43
@salonichf5
Copy link
Contributor Author

salonichf5 commented Aug 13, 2025

Does this have anything specific to our 2.1 release? If not, it can target main.

don't we want these changes in release 2.1 ? Does not have anything specific to release 2.1.

@sjberman
Copy link
Contributor

If we publish to main, then it becomes public immediately. It's not inherently tied to the release, so we could publish it as soon as it's done. And if this doesn't get merged before we release, then the 2.1 branch will be deleted, so we would merge to main anyway.

@salonichf5
Copy link
Contributor Author

If we publish to main, then it becomes public immediately. It's not inherently tied to the release, so we could publish it as soon as it's done. And if this doesn't get merged before we release, then the 2.1 branch will be deleted, so we would merge to main anyway.

Thanks for clarifying, I thought the release branch is our latest branch on changes that get reflected.

@salonichf5 salonichf5 changed the base branch from ngf-release-2.1 to main August 13, 2025 16:51
@sjberman
Copy link
Contributor

Thanks for clarifying, I thought the release branch is our latest branch on changes that get reflected.

Nope, the main branch is what gets published. The release branch is for changes upcoming in our release, that will be merged into main when we release and those features become available.

@salonichf5 salonichf5 force-pushed the docs/architecture-guide branch from 6d7564c to f7c965a Compare August 13, 2025 16:52
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, added edit suggestions for sentence case headings.

There's also an ambiguous sentence that should be reworked.

@sjberman
Copy link
Contributor

Does the rendered version with tables look okay? Not seeing the automatic preview in the PR...

Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Saylor Berman <[email protected]>
@salonichf5
Copy link
Contributor Author

Does the rendered version with tables look okay? Not seeing the automatic preview in the PR...

let me add some screenshots for visibility

@salonichf5
Copy link
Contributor Author

Screenshots to view rendered diagrams and tables @sjberman

Screenshot 2025-08-14 at 1 47 46 PM Screenshot 2025-08-14 at 1 47 53 PM Screenshot 2025-08-14 at 1 48 05 PM

@ADubhlaoich
Copy link
Contributor

As a point of record, there's no automatic preview because the branch for the PR is from a fork.

F5 employees can just branch directly from the repo without forking, which will generate a preview.

@salonichf5 salonichf5 requested a review from a team August 15, 2025 19:01
@salonichf5 salonichf5 merged commit 413acd7 into nginx:main Aug 18, 2025
7 checks passed
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.

3 participants