Google Git
Sign in
apache/pulsar-site

Apache Pulsar Site

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

Branches

  1. 3581b0a Add Node.js client 1.17.0 release note and api (#1106) by Baodi Shi · 2 days ago main
  2. 8b65aed Bump lodash from 4.17.23 to 4.18.1 (#1103) by dependabot[bot] · 4 days ago
  3. 5c2fdff Update params and sample code in OAuth2.0 (#1104) by Hideaki Oguni · 4 days ago
  4. c6cb562 Upgrade npm package by Lari Hotari · 11 days ago
  5. 7311b2e Bump brace-expansion from 1.1.12 to 1.1.13 (#1097) by dependabot[bot] · 11 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