Repository files navigation

This repository contains the source code of the RabbitMQ website, rabbitmq.com.Please make sure to read the Workflow section before contributing.

This repository contains documentation guides for multiple RabbitMQ release series.At the moment they are4.2.x (in development),4.1.x,4.0.x, and3.13.x.

Therefore, the very first question to consder before making any changes is:what versions does my change apply to? Should I update just the4.2.x version,all4.x ones or even3.13.x?

Here is a summary of which version of the documentation corresponds to whichbranch and directory:

Themain branch is the production branch. Commits to it are deployedautomatically towww.rabbitmq.com by a Cloudflare worker.

We keep several versions of the docs in themain branch. Docusaurus uses thefollowing directories:

• docs contains the docs of the future version of RabbitMQ, thus it is thework in progress. It is served athttps://www.rabbitmq.com/docs/next.
• versioned_docs contains one directory per version; for example,versioned_docs/version-4.0. The latest version is served athttps://www.rabbitmq.com/docs. Older versions are served at…/docs/$version.

Changes should be made todocs and to any version they apply. Here is anexample:

# Make changes to the future version’s docs.$EDITOR docs/configure.md# Test the change in a browser.npm start# Once happy, apply to the relevant older release seriescd versioned_docs/version-4.0git diff ../../docs | patch -p2# Test again in a browser.npm start# Commit everything.git add docs versioned_docsgit commit

Please read thedocumentation of Versioning in Docusaurus to learn more.

Older versions of the docs that we don’t want to host in Docusaurus to limitthe number of versions are put in branches of the formv3.13.x,v4.0.x,etc. These branches are deployed automatically too and they use domain names ofthe formv3-13.rabbitmq.com,v4-0.rabbitmq.com, etc. respectively. Notethat these branches used as examples may not exist yet if the correspondingdocs are still maintained in themain branch.

v3.12.x is a bit special in the sense that it is using the old static websitegenerator. This one is deployed by GitHub Actions to a Cloudflare worker. It isavailable athttps://v3-12.rabbitmq.com.

This website is built usingDocusaurus 3, a modernstatic website generator.

You need to install JS components used by Docusaurus first withyarn ornpm.The examples below usenpm.

# for NPM usersnpm install

You need to do this once only.

The following command starts a local development server and opens up a default browserwindow. Most changes are reflected live without having to restart the server.

npm start

To use a different browser, for example, Brave Beta, set theBROWSER env variablewhen runningnpm start:

BROWSER="Brave Beta" npm start

The following command generates static content into thebuild directory andcan be served using any static contents hosting service.

npm run docusaurus'--' build'--dev'

This is important to run this command before pushing changes to GitHub to makesure the build is successful. This is the command that will be used to deploythe website in production.

When a new version series comes out, a separate edition of the docs mustbe explicitly added using

# adds a series for 4.2.xnpm run docusaurus docs:version 4.2

© 2007-2025 Broadcom. All Rights Reserved. The term "Broadcom" refers toBroadcom Inc. and/or its subsidiaries.

The RabbitMQ documentation is dual-licensed under the Apache License 2.0 andthe Mozilla Public License 2.0. Users can choose any of these licensesaccording to their needs. However,the blog is excluded from this license andremains the intellectual property of Broadcom Inc. Blog posts may not berestributed.

SPDX-License-Identifier: Apache-2.0 OR MPL-2.0