-
Notifications
You must be signed in to change notification settings - Fork 121
Description
Summary
This issue tracks an audit of the following documentation page:
Install NGINX Gateway Fabric with Manifests
https://docs.nginx.com/nginx-gateway-fabric/install/manifests/
The page has a low satisfaction score. As of today, the average is 3.17 out of 7 (n=6). In the latest response, a user tried to run the following CLI command in a browser and received a 404 error:
kubectl kustomize "https://github.com/nginx/nginx-gateway-fabric/config/crd/gateway-api/standard?ref=v2.2.1" | kubectl apply -f -The command works as intended when run in a shell but doesn't return results in a browser. The user's attempt to open it in a browser suggests the documentation could provide more context about how and where to run specific commands.
Because this is an onboarding doc and part of a core installation workflow, clarity is especially important. Given this recent feedback and the page's low satisfaction score, a full audit can help identify areas where additional guidance would support a smoother installation experience.
Metrics (current)
- Average score: 3.17 / 7
- Number of responses: 6
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 a core installation workflow with low satisfaction that needs review.
Survey feedback
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