rabbitmq website
1.0.0
Este repositorio contiene el código fuente del sitio web de RabbitMQ, rabbitmq.com. Asegúrese de leer la sección del flujo de trabajo antes de contribuir .
Aquí hay un resumen del cual la versión de la documentación corresponde a qué rama y directorio:
| Versión de Rabbitmq | Rama | Subdirectorio | Servido en |
|---|---|---|---|
| Versión de desarrollo (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 | raíz | v3-12.rabbitmq.com |
La rama main es la rama de producción. Los compromisos se implementan automáticamente en www.rabbitmq.com por un trabajador de CloudFlare.
Mantenemos varias versiones de los documentos en la rama main . Docusaurus usa los siguientes directorios:
docs contiene los documentos de la versión futura de RabbitMQ, por lo tanto, es el trabajo en progreso. Se sirve en https://www.rabbitmq.com/docs/next.versioned_docs contiene un directorio por versión; Por ejemplo, versioned_docs/version-4.0 . La última versión se sirve en https://www.rabbitmq.com/docs. Las versiones anteriores se sirven en …/docs/$version . Se deben realizar cambios en docs y a cualquier versión que apliquen. Aquí hay un ejemplo:
# 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
Lea la documentación de versiones en Docusaurus para obtener más información.
Las versiones más antiguas de los documentos que no queremos alojar en Docusaurus para limitar el número de versiones se colocan en las ramas de la forma v3.13.x , v4.0.x , etc. Estas ramas también se implementan automáticamente y usan nombres de dominio del formulario v3-13.rabbitmq.com , v4-0.rabbitmq.com , etc. respectivamente. Tenga en cuenta que estas ramas utilizadas como ejemplos pueden no existir aún si los documentos correspondientes todavía se mantienen en la rama main .
v3.12.x es un poco especial en el sentido de que está utilizando el antiguo generador de sitios web estáticos. Este es implementado por acciones de GitHub a un trabajador de CloudFlare. Está disponible en https://v3-12.rabbitmq.com.
Este sitio web está construido con Docusaurus 3, un generador de sitios web estático moderno.
Debe instalar los componentes JS utilizados por DocUSaurus primero con yarn o npm . Los ejemplos a continuación usan npm .
# for NPM users
npm installNecesitas de esto solo una vez.
El siguiente comando inicia un servidor de desarrollo local y abre una ventana de navegador predeterminada. La mayoría de los cambios se reflejan en vivo sin tener que reiniciar el servidor.
npm start Para usar un navegador diferente, por ejemplo, Brave Beta, establezca la variable ENV BROWSER al ejecutar npm start :
BROWSER= " Brave Beta " npm start El siguiente comando genera contenido estático en el directorio build y se puede servir utilizando cualquier servicio de alojamiento de contenido estático.
npm run buildEsto es importante para ejecutar este comando antes de empujar los cambios a GitHub para asegurarse de que la compilación sea exitosa. Este es el comando que se utilizará para implementar el sitio web en producción.
© 2007-2024 Broadcom. Reservados todos los derechos. El término "Broadcom" se refiere a Broadcom Inc. y/o sus subsidiarias.
La documentación de RabbitMQ tiene doble licencia bajo la licencia de Apache 2.0 y la Licencia Pública de Mozilla 2.0. Los usuarios pueden elegir cualquiera de estas licencias de acuerdo con sus necesidades. Sin embargo, el blog se excluye de esta licencia y sigue siendo la propiedad intelectual de las publicaciones de blog de Broadcom Inc. no se pueden restablecer.
Identificador SPDX-license: Apache-2.0 o MPL-2.0
