Skip to content

Add simplified architecture diagrams for traffic flow and config changes #3557

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sarthyparty
Copy link
Contributor

Proposed changes

Add simplified architecture diagrams for traffic flow and config changes.

Problem: The current architecture documentation for NGF is written and presented in a way for a new user or developer to be able to understand.

Solution: Adding new diagrams and explanations for how traffic flows and how config changes are applied and the lifecycle of a gateway.

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #3545

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


Copy link

nginx-bot bot commented Jun 26, 2025

Hi @sarthyparty!

Thanks for opening this pull request!
Be sure to check out our Contributing Guidelines while you wait for someone on the team to review this.

@nginx-bot nginx-bot bot added the community label Jun 26, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation chore Pull requests for routine tasks labels Jun 26, 2025
Copy link
Contributor

github-actions bot commented Jun 26, 2025

✅ All required contributors have signed the F5 CLA for this PR. Thank you!
Posted by the CLA Assistant Lite bot.

@sarthyparty
Copy link
Contributor Author

I have hereby read the F5 CLA and agree to its terms

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks community documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

Successfully merging this pull request may close these issues.

Architecture Documentation is Difficult to Learn From
2 participants