Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
  • Qualcosa non va?
#591 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
nginx
Ambito
documentation

Direzione di ricerca

Inizia esaminando la documentazione di prodotto esistente e la KB di supporto K000139565 indicata, quindi confronta le relative indicazioni R22 con i requisiti R34 e le modifiche alla telemetria R33 JWT descritte qui. Il lavoro sarà considerato completato quando sarà disponibile una guida alla migrazione ufficialmente supportata e ricercabile, che copra configurazione e log, telemetria, licenze, i passaggi successivi per Plus API e il reindirizzamento per la deprecazione della KB, con la validazione degli stakeholder.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

customer-success documentation enhancement onboarding P3 - Normal (TTR: 1 month) product/nginx-plus

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

Lingua principale
HTML
Stelle
94
Fork
174
Merge medio
1g 4h
PR unite (30g)
76

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nginx/documentation

Tutte le issue di nginx/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.