rabbitmq website

Site

Este repositório contém o código -fonte do site RabbitMQ, Rabbitmq.com. Certifique -se de ler a seção de fluxo de trabalho antes de contribuir .

Fluxo de trabalho

Tl; dr

Aqui está um resumo de qual versão da documentação corresponde a qual filial e diretório:

Versão do RabbitMQ	Filial	Subdiretório	Servido em
Versão de desenvolvimento (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	raiz	v3-12.rabbitmq.com

Ramificações e versão

O ramo main é o ramo de produção. Comprometes com isso são implantados automaticamente para www.rabbitmq.com por um trabalhador do CloudFlare.

Mantemos várias versões dos documentos no ramo main . Docusaurus usa os seguintes diretórios:

• docs contêm os documentos da versão futura do RabbitMQ, portanto, é o trabalho em andamento. É servido em https://www.rabbitmq.com/docs/next.
• versioned_docs contém um diretório por versão; Por exemplo, versioned_docs/version-4.0 . A versão mais recente é servida em https://www.rabbitmq.com/docs. As versões mais antigas são servidas em …/docs/$version .

As alterações devem ser feitas nos docs e em qualquer versão que eles aplicam. Aqui está um exemplo:

 # 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

Leia a documentação do versão em docusaurus para saber mais.

As versões mais antigas dos documentos que não queremos hospedar em docusaurus para limitar o número de versões são colocadas em ramos do formulário v3.13.x , v4.0.x , etc. Essas ramificações também são implantadas automaticamente e usam nomes de domínio do formulário v3-13.rabbitmq.com , v4-0.rabbitmq.com , etc., respectivamente. Observe que essas filiais usadas como exemplos podem ainda não existir se os documentos correspondentes ainda forem mantidos na filial main .

v3.12.x é um pouco especial no sentido de que está usando o antigo gerador de sites estáticos. Este é implantado pelas ações do GitHub para um trabalhador do CloudFlare. Está disponível em https://v3-12.rabbitmq.com.

Como construir

Este site foi construído usando o Docusaurus 3, um gerador de sites estáticos moderno.

Instalação

Você precisa instalar os componentes JS usados ​​pelo Docusaurus primeiro com yarn ou npm . Os exemplos abaixo usam npm .

 # for NPM users
npm install

Você precisa de isso apenas uma vez.

Desenvolvimento local

O comando a seguir inicia um servidor de desenvolvimento local e abre uma janela padrão do navegador. A maioria das alterações é refletida ao vivo sem precisar reiniciar o servidor.

npm start

Para usar um navegador diferente, por exemplo, beta corajoso, defina a variável Env BROWSER ao executar npm start :

BROWSER= " Brave Beta " npm start

Construir

O comando a seguir gera conteúdo estático no diretório build e pode ser servido usando qualquer serviço de hospedagem de conteúdo estático.

npm run build

Isso é importante para executar esse comando antes de enviar alterações no Github para garantir que a construção seja bem -sucedida. Este é o comando que será usado para implantar o site em produção.

Direitos autorais e licença

© 2007-2024 Broadcom. Todos os direitos reservados. O termo "Broadcom" refere -se à Broadcom Inc. e/ou suas subsidiárias.

A documentação do RabbitMQ é licenciada dupla sob a licença Apache 2.0 e a licença pública de Mozilla 2.0. Os usuários podem escolher qualquer uma dessas licenças de acordo com suas necessidades. No entanto, o blog é excluído desta licença e continua sendo a propriedade intelectual da Broadcom Inc. As postagens do blog podem não ser restringidas.

SPDX-LICense-Identificador: Apache-2.0 ou MPL-2.0