rabbitmq/rabbitmq-website is a open-source project on GitHub, written primarily in JavaScript. It has 1.3k stars. RabbitMQ website
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
This repository contains the source code of the RabbitMQ website, rabbitmq.com.
Please make sure to read the Workflow section before contributing.
Before You Start: Please Sign Our Contributor CLA
If this is your first contribution to RabbitMQ and it involves more than a typo fix,
please sign our contributor CLA.
The process involves one email and one online signature using a legally binding digital signature service.
Sorry about this annoyance and thank you!
Contribution Workflow
TL;DR
This repository contains documentation guides for multiple RabbitMQ release series.
Therefore, the very first question to consider before making any changes is:
what editions (versions) does my change apply to? Should I update just the next release edition,
all 4.x ones or even 3.13.x?
Here is a summary of which version of the documentation corresponds to which
branch and directory:
Version of RabbitMQ
Branch
Sub-directory
Served at
Development version (5.0)
main
docs
www.rabbitmq.com/docs/next
4.4
main
versioned_docs/version-4.4
www.rabbitmq.com/docs
4.3
main
versioned_docs/version-4.3
www.rabbitmq.com/docs/4.3
4.2
main
versioned_docs/version-4.2
www.rabbitmq.com/docs/4.2
4.1
main
versioned_docs/version-4.1
www.rabbitmq.com/docs/4.1
4.0
main
versioned_docs/version-4.0
www.rabbitmq.com/docs/4.0
3.13
main
versioned_docs/version-3.13
www.rabbitmq.com/docs/3.13
3.12
v3.12.x
root
(no longer available)
Branches and Versioning
The main branch is the production branch. Commits to it are deployed
automatically to www.rabbitmq.com.
All editions (versions) of the docs live side by side in the main branch.
Docusaurus uses the following directories:
docs contains the docs of the future version of RabbitMQ, thus it is the
work in progress. It is served at rabbitmq.com/docs/next
versioned_docs contains one directory per version; for example,
versioned_docs/version-4.1. The latest version is served at
rabbitmq.com/docs. Older versions are served at
…/docs/$version, for example rabbitmq.com/docs/3.13.
Changes should be made to docs and to any version they apply. Here is an
example:
# 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 series
cd versioned_docs/version-4.0
git diff ../../docs | patch -p2
# Test again in a browser.
npm start
# Commit everything.
git add docs versioned_docs
git commit
Please read the documentation on versioning in Docusaurus to learn more.
Older versions of the docs that we don’t want to host in Docusaurus to limit
the number of versions are put in branches of the form v3.13.x, v4.0.x,
etc. These branches are deployed automatically too and they use domain names of
the form v3-13.rabbitmq.com, v4-0.rabbitmq.com, etc. respectively. Note
that these branches used as examples may not exist yet if the corresponding
docs are still maintained in the main branch.
How to Build the Site
This website is built using Docusaurus 3, a modern
static website generator.
Dependency Installation
You need to install JS components used by Docusaurus first with yarn or npm.
The examples below use npm.
# for NPM users
npm install
You need to do this once only.
Local Development
The following command starts a local development server and opens up a default browser
window. Most changes are reflected live without having to restart the server.
npm start
To use a different browser, for example, Brave Beta, set the BROWSER env variable
when running npm start:
BROWSER="Brave Beta" npm start
Build
The following command generates static content into the build directory and
can 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 make
sure the build is successful. This is the command that will be used to deploy
the website in production.
How to Add a New Version Series
When a new version series comes out, a separate edition of the docs must
be explicitly added using
# adds a series for 5.0.x
npm run docusaurus docs:version 5.0
The RabbitMQ documentation is dual-licensed under the Apache License 2.0 and
the Mozilla Public License 2.0. Users can choose any of these licenses
according to their needs. However, the blog is excluded from this license and
remains the intellectual property of Broadcom Inc. Blog posts may not be
redistributed.
How active is development on rabbitmq/rabbitmq-website?
The most recent commit recorded on rabbitmq/rabbitmq-website was 1 day ago, based on the GitHub push timestamp. The repository has 829 forks — one of the better signals of community interest.
How many stars does rabbitmq/rabbitmq-website have?
rabbitmq/rabbitmq-website has 1.3k GitHub stars — refresh the page for the live number, or check github.com/rabbitmq/rabbitmq-website. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is rabbitmq/rabbitmq-website open source?
Yes — rabbitmq/rabbitmq-website ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/rabbitmq/rabbitmq-website.
What topics is rabbitmq/rabbitmq-website associated with?
GitHub's repository topics for rabbitmq/rabbitmq-website: "documentation", "rabbitmq", "website". TopGit's editorial category is open-source.
Where can I see rabbitmq/rabbitmq-website in action?
The project maintains a homepage at https://www.rabbitmq.com. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about rabbitmq/rabbitmq-website?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/rabbitmq/rabbitmq-website is the definitive source.
Read full README in the tab above.
Still deciding about rabbitmq-website?
One click hands the question to an AI along with this page — see what it says about rabbitmq-website.