Skip to content

Clean Up Legacy Version References in NGINX Plus Live Activity Monitoring Doc #376

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
travisamartin opened this issue Apr 7, 2025 · 1 comment
Assignees
Labels
community good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)

Comments

@travisamartin
Copy link
Contributor

Overview

The Live Activity Monitoring documentation currently includes numerous references to features introduced in legacy versions of NGINX Plus—some going as far back as R9 (GA in 2016). Since we only support the last two NGINX Plus releases (currently R34 and R33), these older version references are no longer relevant and may confuse readers by framing standard features as “new.”


Why This Matters

  • Calling out features from 2016 (e.g., “introduced in R9”) is outdated in 2025.
  • Removing legacy version callouts simplifies the content and improves readability.
  • It aligns the doc with our support policy and avoids giving unnecessary prominence to deprecated or old versions.

What Needs to Be Done

  • Remove specific version mentions that predate the last two supported releases.
  • Keep the focus on what’s possible now, not what was introduced years ago.
  • Review the full doc for consistency and remove any outdated versioning language.

Suggested Edits (Actual Examples)

1. REST API introduction (R14)

“NGINX REST API available since NGINX Plus Release 14...”
“The NGINX REST API provides extended status information, server and key-value store management...”

2. Superseded modules (R14–R16)

“Note: Prior to NGINX Plus R14... Starting from R16...”
“Earlier versions used the status and upstream_conf modules, which are now fully replaced by the api module.”
Or just:
“The api module replaces the older status and upstream_conf modules for monitoring and management.”

3. Swagger UI and OpenAPI spec (R25–R26)

“Prior to NGINX Plus Release 25, the Swagger UI was shipped... Since NGINX Plus Release 26...”
“The OpenAPI YAML specification and Swagger UI are published separately from NGINX Plus packages.”

Or more succinctly:

“The Swagger UI is no longer bundled with NGINX Plus; it is published separately, below.”


Resources


Impact

This is a small but meaningful update that helps keep the documentation accurate, current, and easier to maintain going forward.

@travisamartin travisamartin added good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com) community labels Apr 7, 2025
@RMDavidson
Copy link
Contributor

RMDavidson commented Apr 15, 2025

  • Do you want any version numbers listed at all?
  • What is the newest version? The section titled Getting statistics with the API uses version 9 as an example in the URL breakdown.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community good first issue Good for newcomers product/nginx-plus NGINX Plus (and NGINX Open Source in docs.ngninx.com)
Projects
None yet
Development

No branches or pull requests

2 participants