Google Git
Sign in
apache/pulsar-site

Apache Pulsar Site

Mirrored from https://github.com/apache/pulsar-site.git
Clone this repo:

Branches

  1. 5ec4083 Docs sync done from apache/pulsar (#a3ae705) by github-actions[bot] · 25 hours ago main
  2. a67ded3 Docs sync done from apache/pulsar (#7f6bc23) by github-actions[bot] · 3 days ago
  3. ff035d3 Return latest feature release series so that doc-tool.sh will update 4.1.x no that it has expired by Lari Hotari · 4 days ago
  4. 978f44f [improve][doc] Clarify producer name uniqueness and Key_Shared batching requirements (#1093) by kevin-pan-skydio · 4 days ago
  5. 572b928 Docs sync done from apache/pulsar (#ae5c70c) by github-actions[bot] · 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

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