該存儲庫包含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