Skip to content

Add flowcharts for NGINX Plus licensing and reporting #1175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 45 commits into from
Sep 30, 2025
Merged

Add flowcharts for NGINX Plus licensing and reporting #1175

merged 45 commits into from
Sep 30, 2025

Conversation

travisamartin
Copy link
Contributor

@travisamartin travisamartin commented Sep 25, 2025 •
edited
Loading

Summary

This PR restructures and rewrites the About subscription licenses documentation to improve clarity, readability, and navigation.

Closes #1049

Key changes

  • Restructure

    • Broke out the former “mega-topic” into smaller standalone docs:
      • Getting started (core licensing guide)
      • Licensing workflows (flowchart)
      • Instructional videos
      • Learn more about related topics
    • Updated landing page with overview and featured cards.

  • Content improvements

    • Applied F5 Modern Voice and simplified language to an 8th–9th grade reading level for a global audience.
    • Used expandos (<details>) and progressive disclosure for deployment/reporting instructions.
    • Added a flowchart based on user feedback requesting a visual reference for easier understanding.
    • Revised alt text, captions, and intros for accessibility and SEO.
    • Reframed negative phrasing into requirement/outcome framing (e.g., startup and reporting checks).

Why

  • Responds directly to user feedback requesting more visual guidance (flowchart).
  • Reduces length and complexity of the original “mega-topic” without adding new content.
  • Improves scannability and accessibility for a global audience.

@travisamartin travisamartin requested a review from a team as a code owner September 25, 2025 22:34
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 25, 2025
@travisamartin travisamartin linked an issue Sep 25, 2025 that may be closed by this pull request
Update & simplify NGINX Plus usage reporting setup docs (R35, with R33 context & FAQ alignment) #1049
Closed
6 tasks
@travisamartin travisamartin changed the title Docs 1049 n plus license workflows Add flow for NGINX Plus licensing and reporting workflows Sep 25, 2025
@travisamartin travisamartin marked this pull request as draft September 25, 2025 22:39
@travisamartin travisamartin changed the title Add flow for NGINX Plus licensing and reporting workflows DRAFT: Add flow for NGINX Plus licensing and reporting workflows Sep 25, 2025
@travisamartin travisamartin self-assigned this Sep 25, 2025
@github-actions GitHub Actions
Copy link

✅ Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1175/

@travisamartin travisamartin changed the title DRAFT: Add flow for NGINX Plus licensing and reporting workflows DRAFT: Add flowcharts for NGINX Plus licensing and reporting Sep 25, 2025
@travisamartin travisamartin marked this pull request as ready for review September 26, 2025 00:01
mjang
mjang reviewed Sep 29, 2025
View reviewed changes
y82
y82 approved these changes Sep 29, 2025
View reviewed changes
@y82
Copy link
Contributor

y82 commented Sep 29, 2025

twimc - I didn't check the flowcharts, only licensing texts/procedures

travisamartin and others added 2 commits September 29, 2025 14:11
@travisamartin @y82
Apply suggestions from code review
7a06290 
Co-authored-by: yar <y82@users.noreply.github.com>
@travisamartin
edits per tech review
c44b7ac
mtbChef
mtbChef reviewed Sep 29, 2025
View reviewed changes
mjang
mjang approved these changes Sep 30, 2025
View reviewed changes
Copy link
Contributor

@mjang mjang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 4 different images are great -- they're pretty "self-documenting". I'm guessing people will stare at them for a few minutes and think "ah hah!"

@travisamartin travisamartin added product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com) customer-success labels Sep 30, 2025
@travisamartin travisamartin merged commit 69a4d40 into main Sep 30, 2025
9 checks passed
@travisamartin travisamartin deleted the docs-1049-n-plus-license-workflows branch September 30, 2025 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtbChef mtbChef mtbChef left review comments

@mjang mjang mjang approved these changes

@y82 y82 y82 approved these changes

@JTorreG JTorreG JTorreG approved these changes

@mkingst mkingst Awaiting requested review from mkingst

Assignees

@travisamartin travisamartin

Labels
customer-success documentation Improvements or additions to documentation product/nginx-plus Issues related to NGINX Plus (and NGINX Open Source in docs.nginx.com)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update & simplify NGINX Plus usage reporting setup docs (R35, with R33 context & FAQ alignment)
5 participants
@travisamartin @y82 @mjang @mtbChef @JTorreG