generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 110
Open
Open
Update & simplify NGINX Plus usage reporting setup docs (R35, with R33 context & FAQ alignment)#1049
Enhancement
Copy link
Labels
🔥 p2Priority 2: Impacts production; non-emergencyPriority 2: Impacts production; non-emergencycustomer-success
Description
Description
We need to improve the documentation for setting up NGINX Plus usage reporting. This feature has been required since R33, and with R35, some functionality has changed. The current materials are too wordy and difficult to parse, which makes setup harder than it should be.
Our goal is to make the documentation clear, concise, and accurate, while highlighting what’s changed between releases.
Tasks
- Audit existing messaging for readability. Target 8th–9th grade level.
- Reduce cognitive load: use plain language (F5 Modern Voice), headings, bullets, and tables instead of long text blocks.
- Add diagrams (Mermaid) to explain setup steps, data reporting flow, and key decision points (e.g., grace period outcomes).
- Update for R35: confirm instructions reflect current functionality, and clearly call out differences from R33.
- Review and align FAQ with main docs so users can trust both sources.
- Ensure step-by-step setup instructions are concise, actionable, and minimal-effort to follow.
Acceptance criteria
- Content reads at ~8–9th grade level and is scannable.
- Docs reflect R35 functionality, with differences from R33 clearly noted.
- FAQ is aligned with main docs and written in plain language.
- Visuals (Mermaid diagrams) replace or simplify dense text.
- Users can complete setup successfully without additional support.
Metadata
Metadata
Assignees
Labels
🔥 p2Priority 2: Impacts production; non-emergencyPriority 2: Impacts production; non-emergencycustomer-success