rabbitmq website
1.0.0
Ce référentiel contient le code source du site Web de RabbitMQ, Rabbitmq.com. Veuillez vous assurer de lire la section du flux de travail avant de contribuer .
Voici un résumé de quelle version de la documentation correspond à quelle branche et répertoire:
| Version de Rabbitmq | Bifurquer | Sous-répertoire | Servi à |
|---|---|---|---|
| Version de développement (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 | racine | v3-12.rabbitmq.com |
La branche main est la branche de production. Les engagements sont déployés automatiquement sur www.rabbitmq.com par un travailleur CloudFlare.
Nous conservons plusieurs versions des documents dans la branche main . Docusaurus utilise les répertoires suivants:
docs contient les documents de la future version de Rabbitmq, c'est donc le travail en cours. Il est servi sur https://www.rabbitmq.com/docs/next.versioned_docs contient un répertoire par version; Par exemple, versioned_docs/version-4.0 . La dernière version est servie sur https://www.rabbitmq.com/docs. Les versions plus anciennes sont servies à …/docs/$version . Des modifications doivent être apportées aux docs et à toute version qu'ils appliquent. Voici un exemple:
# 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
Veuillez lire la documentation du versioning dans Docusaurus pour en savoir plus.
Les anciennes versions des documents que nous ne voulons pas héberger dans Docusaurus pour limiter le nombre de versions sont placées dans les branches du formulaire v3.13.x , v4.0.x , etc. Ces branches sont également déployées automatiquement et utilisent respectivement les noms de domaine du formulaire v3-13.rabbitmq.com , v4-0.rabbitmq.com , etc. Notez que ces branches utilisées comme exemples peuvent ne pas encore exister si les documents correspondants sont toujours maintenus dans la branche main .
v3.12.x est un peu spécial dans le sens où il utilise l'ancien générateur de sites Web statique. Celui-ci est déployé par GitHub Actions à un travailleur CloudFlare. Il est disponible sur https://v3-12.rabbitmq.com.
Ce site Web est construit à l'aide de Docusaurus 3, un générateur de site Web statique moderne.
Vous devez d'abord installer les composants JS utilisés par Docusaurus avec yarn ou npm . Les exemples ci-dessous utilisent npm .
# for NPM users
npm installVous devez en faire une seule fois.
La commande suivante démarre un serveur de développement local et ouvre une fenêtre de navigateur par défaut. La plupart des modifications sont reflétées en direct sans avoir à redémarrer le serveur.
npm start Pour utiliser un navigateur différent, par exemple, Brave Beta, définissez la variable Env BROWSER lors de l'exécution npm start :
BROWSER= " Brave Beta " npm start La commande suivante génère du contenu statique dans le répertoire build et peut être servi à l'aide de tout service d'hébergement de contenu statique.
npm run buildIl est important d'exécuter cette commande avant de pousser les modifications à GitHub pour s'assurer que la construction réussit. Il s'agit de la commande qui sera utilisée pour déployer le site Web en production.
© 2007-2024 Broadcom. Tous droits réservés. Le terme "Broadcom" fait référence à Broadcom Inc. et / ou à ses filiales.
La documentation RabbitMQ est à double licence en vertu de la Licence 2.0 Apache et de la Licence publique Mozilla 2.0. Les utilisateurs peuvent choisir l'une de ces licences en fonction de leurs besoins. Cependant, le blog est exclu de cette licence et reste la propriété intellectuelle de Broadcom Inc. Les articles de blog peuvent ne pas être restreintes.
SPDX-license-Identificateur: Apache-2.0 ou MPL-2.0
