このリポジトリには、RabbitMQ Webサイト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ワーカーによってwww.rabbitmq.comに自動的に展開されます。
mainブランチにドキュメントのいくつかのバージョンを保持しています。 Docusaurusは次のディレクトリを使用しています。
docsには、rabbitmqの将来バージョンのドキュメントが含まれているため、進行中の作業です。 https://www.rabbitmq.com/docs/nextで提供されています。versioned_docsには、バージョンごとに1つのディレクトリが含まれています。たとえば、 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などのドメイン名も使用します。対応するドキュメントがまだmainブランチに維持されている場合、例として使用されるこれらのブランチはまだ存在しない可能性があることに注意してください。
v3.12.x 、古い静的Webサイトジェネレーターを使用しているという意味で少し特別です。これは、GitHubアクションによってCloudFlareワーカーに展開されます。 https://v3-12.rabbitmq.comで入手できます。
このWebサイトは、最新の静的WebサイトジェネレーターであるDocusaurus 3を使用して構築されています。
最初にyarnまたはnpmでDocusaurusで使用されるJSコンポーネントをインストールする必要があります。以下の例では、 npmを使用しています。
# for NPM users
npm installこれは一度だけである必要があります。
次のコマンドはローカル開発サーバーを起動し、デフォルトのブラウザウィンドウを開きます。ほとんどの変更は、サーバーを再起動することなくライブで反映されます。
npm startたとえば、Brave Betaなど、別のブラウザを使用するには、 npm start実行するときにBROWSER ENV変数を設定します。
BROWSER= " Brave Beta " npm start次のコマンドは、静的コンテンツをbuildディレクトリに生成し、静的コンテンツホスティングサービスを使用して提供できます。
npm run buildこれは、ビルドが成功していることを確認するために、GitHubに変更をプッシュする前にこのコマンドを実行することが重要です。これは、Webサイトの展開に使用されるコマンドです。
©2007-2024 Broadcom。無断転載を禁じます。 「Broadcom」という用語は、Broadcom Inc.および/またはその子会社を指します。
RabbitMQドキュメントは、Apacheライセンス2.0およびMozilla Public License 2.0の下で二重ライセンスが付けられています。ユーザーは、ニーズに応じてこれらのライセンスのいずれかを選択できます。ただし、ブログはこのライセンスから除外されており、Broadcom Incの知的財産のままです。ブログ投稿は制限されない場合があります。
SPDX-License-Identifier:Apache-2.0またはMPL-2.0