Skip to content

Architecture Documentation is Difficult to Learn From #3545

Open
@mpstefan

Description

@mpstefan

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

No one assigned

    Labels

    backlogCurrently unprioritized work. May change with user feedback or as the product progresses.documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    Status

    🆕 New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions