-
Notifications
You must be signed in to change notification settings - Fork 121
Description
What would you like the documentation team to work on?
Summary
This issue tracks an audit of the following documentation page:
Install NGINX Gateway Fabric with Helm
https://docs.nginx.com/nginx-gateway-fabric/install/helm/
The page currently has the lowest satisfaction score of all NGINX Gateway Fabric installation content. As of now, its lifetime average is 2.42 out of 7 (n=12), and the trend has declined further since July. No specific user feedback is available, but the downward trend suggests that readers may be encountering friction or unclear instructions. A full audit is recommended to assess clarity, task success, and alignment with current Helm usage patterns.
Metrics (current)
- Lifetime average: 2.42 / 7
- Number of responses: 12
- Satisfaction trend has declined since July 1, 2025
Actions
- Run an end-to-end test to confirm the workflow works as documented
- Identify missing context or unclear guidance in command usage
- Check that GitHub links and versioned paths work as expected
- Make sure prerequisites, steps, and callouts are clear and complete
- Flag instructions that could confuse users or lead to errors
- Edit the page to match the NGINX style guide reading level (8th–9th grade)
- Update the doc catalog for this page and its includes (e.g.,
DOCS-1430) with the reviewed-on date - Monitor satisfaction scores after updates are published
Priority
P2
This is an installation doc with the lowest satisfaction score in the set and should be reviewed.
Survey responses
Which product or products does this problem relate to?
NGINX Gateway Fabric
If necessary, explain any additional steps to reproduce the problem.
No response
What is the expected or desired behaviour?
No response
Is this problem specific to a particular platform or software version?
No response
Any additional information
No response
Which product or products does this request relate to?
NGINX Gateway Fabric
Who is the person directly responsible for initiating this request?
Is this request part of a larger initiative or project?
Audit for low-performing onboarding docs
Are there important constraints for this request?
N/A
Does this request have a due date?
See Priority
Any additional information
No response