[docs] Align documentation with Pulsar 5.0 capabilities and upgrade paths - #1235
Merged
lhotari merged 2 commits intoSep 30, 2026
Merged
Conversation
- 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.
merlimat
approved these changes
Sep 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
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 enpassed for current and 5.0.x docs, andgit diff --checkpassed. The build still reports existing, unrelated/community/anchor warnings. The 5.0.x docs matchdocs/; 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