Skip to content

Create official migration guide from NGINX Open Source to NGINX Plus in product documentation #591

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.

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

Open
6 tasks
travisamartin opened this issue May 22, 2025 · 0 comments
Labels
customer-success documentation Improvements or additions to documentation enhancement New feature or request onboarding product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)

Comments

@travisamartin
Copy link
Contributor

Description

There is currently no official documentation in the product docs for migrating from NGINX Open Source (NOSS) to NGINX Plus (N+), even though this is:

  • A common customer use case
  • A high-priority business objective (NGINX Plus is our primary revenue driver)

There is a support KB article that addresses the topic:
https://my.f5.com/manage/s/article/K000139565

However, it is outdated and minimal:

  • It targets NGINX Plus R22. The current version is R34.
  • Significant changes were introduced in R33 related to JWT-based telemetry reporting, which are not covered.
  • There’s no guidance on post-migration steps, such as how to get value from the Plus API or other advanced features.

This gap puts customers at risk of:

  • Incomplete or broken migrations
  • Delayed time to value
  • Overlooking NGINX Plus-only features
  • Increased support requests

Goals / What needs to be documented

  1. A clear, step-by-step migration guide for moving from NGINX Open Source to NGINX Plus
  2. Instructions for:
    • Backing up and moving configuration and logs
    • Aligning with the correct target version (R34+)
    • Accounting for JWT telemetry changes starting in R33
  3. A “What to do next” section to help users begin using core NGINX Plus features immediately (for example, enabling the NGINX Plus API for metrics)
  4. Notes on how NGINX Plus differs from NOSS in areas like licensing, telemetry, and monitoring

Acceptance criteria

  • Product documentation includes an up-to-date, officially supported migration guide from NOSS to NGINX Plus
  • Content includes context and caveats for versions R33 and newer (especially around telemetry)
  • Post-migration usage recommendations are included to accelerate time to value
  • Support KB (K000139565) is deprecated and redirects to the new official documentation
  • Documentation is searchable using common migration-related terms
  • Reviewed and validated by stakeholders across Docs, Product, Support, and Engineering

References

@travisamartin travisamartin added documentation Improvements or additions to documentation product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) customer-success enhancement New feature or request onboarding labels May 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-success documentation Improvements or additions to documentation enhancement New feature or request onboarding product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

No branches or pull requests

1 participant