rabbitmq website

Веб -сайт

Этот репозиторий содержит исходный код веб -сайта RabbitMQ, Rabbitmq.com. Пожалуйста, обязательно прочитайте раздел рабочего процесса, прежде чем внести свой вклад .

Рабочий процесс

TL; DR

Вот краткое изложение того, какая версия документации соответствует какой филиале и каталоге:

Версия 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 филиал является производственная филиал. Коммитом к нему автоматически развернута на www.rabbitmq.com работником CloudFlare.

Мы держим несколько версий документов в 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 и т. Д. Соответственно. Обратите внимание, что эти ветви, используемые в качестве примеров, еще не могут существовать, если соответствующие документы все еще сохраняются в main ветви.

v3.12.x немного особенный в том смысле, что он использует старый статический генератор веб -сайтов. Этот развернут действиями GitHub для работника CloudFlare. Он доступен по адресу https://v3-12.rabbitmq.com.

Как построить

Этот веб -сайт построен с использованием Docusaurus 3, современного статического генератора веб -сайтов.

Установка

Вам нужно установить компоненты JS, используемые Docusaurus, сначала с yarn или npm . Примеры ниже используют npm .

 # for NPM users
npm install

Вам нужно это только один раз.

Местное развитие

Следующая команда запускает локальный сервер разработки и открывает окно браузера по умолчанию. Большинство изменений отражаются в прямом эфире без необходимости перезапуска сервера.

npm start

Например, для использования другого браузера, смелой бета -версии, установите переменную Env BROWSER при npm start :

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-идентификатор: Apache-2.0 или MPL-2.0