Google Git
Sign in
apache / pulsar-site / 43da7252d8a25f94928238f2eb63f93dd426d03b
commit43da7252d8a25f94928238f2eb63f93dd426d03b[log] [tgz]
authorLari Hotari <lhotari@users.noreply.github.com>Mon Sep 08 14:51:35 2025 +0300
committerLari Hotari <lhotari@users.noreply.github.com>Mon Sep 08 14:51:35 2025 +0300
treee919f2747a3ae0b6f200b0263105ada63cacfe93
parent789cfbafe20fcaf1dad49c5f2a595657c0abf249 [diff]
Add instructions for new feature releases
1 file changed
tree: e919f2747a3ae0b6f200b0263105ada63cacfe93
  1. .github/
  2. blog/
  3. client-feature-matrix/
  4. contribute/
  5. data/
  6. diagrams/
  7. docs/
  8. release-notes/
  9. scripts/
  10. security/
  11. src/
  12. static/
  13. tmp/
  14. tools/
  15. versioned_docs/
  16. versioned_sidebars/
  17. .asf.yaml
  18. .dockerignore
  19. .editorconfig
  20. .gitignore
  21. .yarnrc.yml
  22. babel.config.js
  23. docker-compose.yaml
  24. Dockerfile
  25. docusaurus.config.ts
  26. matomoClientModule.ts
  27. package.json
  28. preview.sh
  29. README.md
  30. releases.json
  31. sidebars.js
  32. sidebars.json
  33. sidebarsDevelopment.js
  34. sidebarsReleaseNotes.js
  35. site-baseurls.js
  36. tsconfig.json
  37. versions.json
  38. yarn.lock
README.md

Apache Pulsar Website and Documentation

This repository contains the Apache Pulsar website source code and Apache Pulsar documentation.

Apache Pulsar is an open-source, distributed messaging and streaming platform built for the cloud.

Quick start: Updating documentation and previewing changes

Make changes to the documentation in the docs directory.

To preview the changes, run the following command (prerequisites):

./preview.sh

This command starts a local web server on port 3000 and opens a browser window pointing to the website.

Updating versioned docs

When your documentation changes apply to existing supported versions, you should update both the versioned documentation in the versioned_docs directory and the documentation in the docs directory.

# List all supported major.minor.x versions
./scripts/docs-tool.sh supported_versions

After committing the changes for the docs directory, you can use the docs-tool to apply the changes to the versioned docs. This tool is a wrapper around git diff and patch. If the patch is not applied correctly, you will have to manually apply the changes to the versioned docs.

./scripts/docs-tool.sh apply_changes_to_versioned_docs

More information

Contact information