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

• Pulsar Website contribution guide
  • How to update data-driven pages on the website
• Pulsar Documentation contribution guide
  • Updating documentation
  • Previewing content

Website not getting updated?

If the https://pulsar.apache.org website doesn't get updated, check the latest GitHub Actions workflow run for the main branch. If it succeeded, the problem could be that the git history for the asf-site-next branch is too large and needs to be truncated. Here are the commands to perform that task:

git clone -b asf-site-next https://github.com/apache/pulsar-site pulsar-site-static
cd pulsar-site-static
git checkout --orphan asf-site-next-reset
git add -A
git commit -m "History resetted"
git push -f HEAD:asf-site-next

Contact information

• Submit an issue on the main apache/pulsar repo
• Subscribe to the [email protected] mailing list and start a discussion.
• Ask on the #dev channel on Pulsar Slack (join)