网站

本仓库包含 RabbitMQ 网站 rabbitmq.com 的源代码。 请在贡献之前务必阅读 Workflow 部分。

开始之前：请签署我们的贡献者 CLA

如果这是您首次为 RabbitMQ 做出贡献，且内容超出了错别字修正，请签署我们的贡献者 CLA。

该流程涉及一封电子邮件和一次使用具有法律约束力的数字签名服务进行的在线签名。

对此带来的不便深表歉意，并感谢您的配合！

贡献工作流

摘要

本仓库包含多个 RabbitMQ 发布系列的文档指南。

因此，在进行任何更改之前，首先要考虑的问题是：我的更改适用于哪些版本（edition）？我应该只更新下一个发布版本，还是所有 4.x 个版本，甚至是 3.13.x？

以下是文档版本与分支和目录对应关系的摘要：

RabbitMQ 版本	分支	子目录	提供于
开发版本 (4.4)	`main`	`docs`	`www.rabbitmq.com/docs/next`
4.3	`main`	`versioned_docs/version-4.3`	`www.rabbitmq.com/docs`
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	(不再可用)

分支与版本控制

main 分支是生产分支。提交到该分支的内容会自动部署到 www.rabbitmq.com。

所有文档版本（editions）都并列存放在 main 分支中。

Docusaurus 使用以下目录：

docs 包含 RabbitMQ 未来版本的文档，因此它是正在进行的工作。它通过 rabbitmq.com/docs/next 提供服务
versioned_docs 每个版本包含一个目录；例如， versioned_docs/version-4.1。最新版本通过 rabbitmq.com/docs 提供服务。旧版本通过 …/docs/$version 提供服务，例如 rabbitmq.com/docs/3.13。

更改应针对 docs 以及任何适用的版本进行。以下是一个示例：

# 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

请阅读 Docusaurus 中的版本管理文档] 以了解更多信息。

我们不想在 Docusaurus 中托管以限制版本数量的旧版文档，会被放置在形式为 v3.13.x、v4.0.x 等的分支中。这些分支也会自动部署，并分别使用形式为 v3-13.rabbitmq.com、v4-0.rabbitmq.com 等的域名。请注意，如果相应的文档仍在 main 分支中维护，则用作示例的这些分支可能尚不存在。

如何构建站点

本网站使用 Docusaurus 3 构建，这是一个现代静态网站生成器。

依赖安装

您需要先使用 yarn 或 npm 安装 Docusaurus 使用的 JS 组件。以下示例使用 npm。

# for NPM users
npm install

你只需执行一次。

本地开发

以下命令会启动一个本地开发服务器，并打开一个默认浏览器窗口。大多数更改无需重启服务器即可实时反映。

npm start

若要使用其他浏览器，例如 Brave Beta，请在运行 npm start 时设置 BROWSER 环境变量：

BROWSER="Brave Beta" npm start

构建

以下命令会将静态内容生成到 build 目录中，并可使用任何静态内容托管服务进行部署。

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

在将更改推送到 GitHub 之前运行此命令非常重要，以确保构建成功。这是用于在生产环境中部署网站的命令。

如何添加新的版本系列

当新的版本系列发布时，必须使用

# adds a series for 4.3.x
npm run docusaurus docs:version 4.3

版权与许可

RabbitMQ 文档采用 Apache License 2.0 和 Mozilla Public License 2.0 双重许可。用户可以根据其需求选择其中任一许可证。但是，博客不在此许可范围内，仍为 Broadcom Inc. 的知识产权。 博客文章不得再分发。

SPDX

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