Apache Pulsar Site

Clone this repo:
  1. 05c005f Update release notes guide by Lari Hotari · 4 days ago main
  2. 9981ad6 update java-apidoc for 4.1.1 by Lari Hotari · 4 days ago
  3. 2cd9d89 update java-apidoc for 4.0.7 by Lari Hotari · 4 days ago
  4. f8d1f6e update java-apidoc for 3.3.9 by Lari Hotari · 4 days ago
  5. be5fbb7 Delete target api doc directory before copying by Lari Hotari · 4 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