nginx-gateway-fabric icon indicating copy to clipboard operation
nginx-gateway-fabric copied to clipboard

Top Level Landing Page for NGF Documentation

Open mpstefan opened this issue 8 months ago • 0 comments
trafficstars

As a potential user of NGF I want to see a landing page for NGF documentation that can guide me to the documentation I am looking for So that I can quickly answer my questions about NGF and determine if it fits my environment.

Specific User Stories

As a user of Kubernetes who has heard about NGF I want to understand what NGF is and how it works at a high level So that I can understand how NGF can help me in Kubernetes

As a platform architect investigating new tools for my Kubernetes environments I want to be guided to information related to the architecture and design concepts of NGF So that I can determine whether or not NGF fits my organization's needs for security, performance, and compatibility.

As a platform engineer investigating new tools for my Kubernetes environment I want to be guided to information that shows me what use cases are covered by NGINX So that I can determine whether or not NGF fits the use cases I need for my environment.

As a platform engineer looking to evaluate infrastructure tools for my Kubernetes environment I want instructions to quickly install NGF into my Kubernetes cluster So that I can quickly evaluate NGF's and the Gateway API's ability to improve our Kubernetes application development.

As a cluster operator using NGF in my Kubernetes clusters I want to quickly diagnose an issue that I believe originates in NGF So that I can minimize downtime of my environment.

As a cluster operator using NGF in my Kubernetes clusters who already knows how to use the Gateway API I want to quickly view reference documentation for NGF So that I can quickly reference the configuration I need without going to a guide or blog.

Acceptance

  • The default landing page for NGINX Gateway Fabric includes:
    • A description of what the product is and why it exists.
    • A basic architecture diagram that shows how NGF supports Kubernetes cluster networking
    • A link to documentation showing architectural and design concepts
    • A link to documentation showing what use cases are covered by NGF
    • A link to documentation for users who want to install NGF
    • A link to documentation for users who are looking to troubleshoot NGF in their environment
    • A link to documentation for users who want to view reference documentation

mpstefan avatar Mar 21 '25 20:03 mpstefan