Apache Pulsar Site

Clone this repo:
  1. b98f65a Remove out-dated resources page and related "Older Articles" content by Lari Hotari · 2 days ago main
  2. 5d8d897 Docs sync done from apache/pulsar (#fcd5f92) by github-actions[bot] · 5 days ago
  3. 315c844 Docs sync done from apache/pulsar (#45d71f8) by github-actions[bot] · 6 days ago
  4. 5c3bb99 Add Oxia metadata store support and update transaction configurations (#1034) by Penghui Li · 8 days ago
  5. daa36c9 Docs sync done from apache/pulsar (#a035c6e) by github-actions[bot] · 9 days ago

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