Skip to content

[docs] Align documentation with Pulsar 5.0 capabilities and upgrade paths - #1235

Merged
lhotari merged 2 commits into
apache:mainfrom
lhotari:docs/pulsar-5.0-documentation-squashed
Sep 30, 2026
Merged

lhotari merged 2 commits into
apache:mainfrom
lhotari:docs/pulsar-5.0-documentation-squashed

Conversation

@lhotari

@lhotari lhotari commented Sep 30, 2026

Copy link
Copy Markdown
Member

This brings the current documentation in line with Pulsar 5.0 and refreshes the 5.0.x versioned docs from that baseline. The release highlights put Scalable Topics alongside performance and reliability improvements for existing workloads, with a clear distinction between upgrading a cluster and adopting new capabilities.

  • Add dedicated 5.0.x upgrade guidance covering rollback preparation, configuration defaults, metrics, applications, Functions, plugins, and standalone instances.
  • Expand Scalable Topics and v5 Java client guidance while clarifying continued v4 client and existing-topic compatibility.
  • Centralize Java dependency setup and Netty alignment, and update authentication, TLS, and security guidance.
  • Document broker performance tuning, ZGC and Linux memory settings, monitoring, and system performance testing.
  • Refresh deployment, Helm, metadata-store, load-balancing, connector, and contributor documentation.
  • Improve navigation, redirects, shared version variables, and table readability, and add automatic release-note links.

I suggest merging this as the documentation baseline and revisiting the details through focused follow-up PRs. That should let us efficiently improve the content from a shared baseline rather than hold the full update while refining every detail.

Validation: yarn build --locale en passed for current and 5.0.x docs, and git diff --check passed. The build still reports existing, unrelated /community/ anchor warnings. The 5.0.x docs match docs/; their sidebar matches the current sidebar with version-specific links resolved.

The versioned documentation refresh is a separate commit from the main documentation update.

Contribution checklist

  • Updated the 5.0.x versioned docs and sidebar.

- Highlight Scalable Topics, broker performance, reliability, and compatibility.
- Add dynamic release-note links and a reusable release-highlights workflow.
- Separate 5.0 upgrade guidance from general cluster upgrade procedures.
- Document rollback preparation, configuration defaults, and metrics changes.
- Cover application, Functions, plugin, and standalone upgrade requirements.
- Expand Scalable Topics concepts, administration, transactions, and v5 APIs.
- Standardize v4/v5 client terminology and recommend unified Java packaging.
- Centralize Java dependency setup, Netty alignment, and tracing guidance.
- Explain broker performance tuning, ZGC, Linux memory settings, and benchmarks.
- Complete Prometheus and OpenTelemetry coverage and expand monitoring options.
- Update metadata stores, load balancing, logging, and operational procedures.
- Clarify TLS providers, authentication, authorization, and network security.
- Refresh deployment, Helm, connector, Functions, and storage documentation.
- Update Gradle development, release validation, and performance testing guides.
- Improve navigation, redirects, table readability, and shared version variables.
@lhotari
lhotari requested a review from merlimat September 30, 2026 23:35
@lhotari
lhotari merged commit 27681e0 into apache:main Sep 30, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants