Open
Description
Is your enhancement request related to a problem? Please describe.
The current architecture documentation for NGF is written and presented in a way for a new user or developer to be able to understand.
What would you like to be added:
Some feedback on issues with the current documentation:
- The Mermaid diagrams have small font and include too much information per diagram.
- The relationship NGF has with the Kubernetes API is dubious just looking at the Diagram.
- No clearly visible explanation of what our control and data planes are despite using the terms consistently throughout.
- No sequence diagrams for config changes, traffic, etc
- Gateway API objects do not reference the Kubernetes API in the diagram.
- The component overview section seems to mix sequence and general descriptions.
To solve some of these issues, we may need:
- Two separate diagrams. One showing how configuration is applied, the other showing how traffic flows.
- Custom diagram images or changes to the Mermaid format for readability.
- A clear and visible description of what NGF's control and data planes are.
Why this is needed:
So new developers or users can quickly understand our architecture without giving up and/or seeking a new product.
Metadata
Metadata
Assignees
Labels
Type
Projects
Status
🆕 New