Convert NGINX Ingress Controller examples into product documentation #603
Description
Overview
As a NGINX Ingress Controller user, I want examples in product documentation, So I can see and follow specific use cases.
Description
DocOps has started to use our user feedback and interaction data to discover what content people seem to struggle the most with. One clear pattern is negative feedback for pages that redirect users to GitHub for instructions, which is one more "hop" in their user journey, to a completely separate platform.
A pull request in the NGINX Ingress Controller example showed how these GitHub instructions could be converted into live production documentation, while still single-sourcing the YAML files of the respective use cases.
Not only will it remove the friction from the current state of documentation, it will also surface use cases potential readers might be unaware of.
This ticket encompasses converting all remaining examples into production documentation. NGINX Gateway Fabric has a similar pattern of example use case instructions being stored solely in its GitHub repo, and a sibling ticket will be created for it at a later stage.
Tasks
- Convert all of the custom resource examples to documentation
- Convert all the ingress resource examples to documentation
- Convert all the shared examples to documentation
Following the convention set by the example pull request, ensure that the READMEs for each example link to the respective production document URL (Retaining context), so that discoverability is not harmed.
Acceptance criteria
- The user can find all use cases through the documentation website
- The user can follow links from the repository examples to the respective website document
Metadata
Metadata
Assignees
Labels
Type
Projects
Status