该存储库包含RabbitMQ网站Rabbitmq.com的源代码。在贡献之前,请确保阅读工作流程部分。
这是文档的哪个版本对应于哪个分支和目录的摘要:
| RabbitMQ的版本 | 分支 | 子目录 | 在 |
|---|---|---|---|
| 开发版本(4.1) | main | docs | www.rabbitmq.com/docs/next |
| 4.0 | main | versioned_docs/version-4.0 | www.rabbitmq.com/docs |
| 3.13 | main | versioned_docs/version-3.13 | www.rabbitmq.com/docs/3.13 |
| 3.12 | v3.12.x | 根 | v3-12.rabbitmq.com |
main分支是生产分支。 Cloudflare Worker会自动将其部署到www.rabbitmq.com。
我们将文档的几个版本保留在main分支中。 Docusaurus使用以下目录:
docs包含RabbitMQ的未来版本的文档,因此正在进行中。它可以在https://www.rabbitmq.com/docs/next上提供。versioned_docs每个版本包含一个目录;例如, versioned_docs/version-4.0 。最新版本可在https://www.rabbitmq.com/docs上使用。旧版本以…/docs/$version提供。应该对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等表单v3-13.rabbitmq.com等。请注意,如果相应的文档仍保留在main分支中,则可能尚不存在这些用作示例的分支。
v3.12.x在使用旧静态网站生成器的意义上有点特别。这是由GitHub动作部署到Cloudflare工人的。它可在https://v3-12.rabbitmq.com上找到。
该网站是使用现代静态网站生成器Docusaurus 3构建的。
您需要先安装Docusaurus使用的JS组件,首先使用yarn或npm安装。下面的示例使用npm 。
# for NPM users
npm install您只需要一次。
以下命令启动了本地开发服务器,并打开默认浏览器窗口。大多数更改无需重新启动服务器即可反映。
npm start要使用其他浏览器,例如勇敢的beta,请在运行npm start时设置BROWSER Env变量:
BROWSER= " Brave Beta " npm start以下命令会在build目录中生成静态内容,并且可以使用任何静态内容托管服务提供服务。
npm run build在将更改推向GitHub之前,以确保构建成功,这很重要。这是用于在生产中部署网站的命令。
©2007-2024 Broadcom。版权所有。 “ Broadcom”一词是指Broadcom Inc.和/或其子公司。
RabbitMQ文档根据Apache许可证2.0和Mozilla公共许可证2.0进行双重许可。用户可以根据需要选择任何这些许可证。但是,该博客被排除在此许可之外,并且仍然是Broadcom Inc.的知识产权。博客文章可能不受限制。
SPDX-LICENSE-IDIFIER:APACHE-2.0或MPL-2.0