rabbitmq website
1.0.0
Dieses Repository enthält den Quellcode der Rabbitmq -Website Rabbitmq.com. Bitte lesen Sie den Workflow -Abschnitt vor, bevor Sie dazu beitragen .
Hier finden Sie eine Zusammenfassung, welche Version der Dokumentation dem entspricht, welcher Zweig und Verzeichnis: Verzeichnis:
| Version von Rabbitmq | Zweig | Unterverzeichnis | Serviert bei |
|---|---|---|---|
| Entwicklungsversion (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 | Wurzel | v3-12.rabbitmq.com |
Der main ist der Produktionszweig. Commits the It werden automatisch von einem CloudFlare -Mitarbeiter für www.rabbitmq.com bereitgestellt.
Wir behalten mehrere Versionen der Dokumente im main . Docusaurus verwendet die folgenden Verzeichnisse:
docs enthält die Dokumente der zukünftigen Version von Rabbitmq, daher ist es die laufende Arbeit. Es wird unter https://www.rabbitmq.com/docs/next serviert.versioned_docs enthält ein Verzeichnis pro Version; Zum Beispiel versioned_docs/version-4.0 . Die neueste Version wird unter https://www.rabbitmq.com/docs serviert. Ältere Versionen werden bei …/docs/$version serviert. Änderungen sollten an docs und an jeder Version vorgenommen werden, die sie anwenden. Hier ist ein Beispiel:
# 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
Bitte lesen Sie die Dokumentation der Versionierung in Docusaurus, um mehr zu erfahren.
Ältere Versionen der Dokumente, die wir nicht in Docusaurus hosten möchten, um die Anzahl der Versionen zu begrenzen, werden in Zweige des Formulars v3.13.x , v4.0.x usw. eingesetzt. Diese Filialen werden automatisch auch automatisch bereitgestellt und verwenden Domain-Namen des Formulars v3-13.rabbitmq.com , v4-0.rabbitmq.com usw. usw. Beachten Sie, dass diese als Beispiele verwendeten Zweige möglicherweise noch nicht existieren, wenn die entsprechenden Dokumente noch im main aufrechterhalten werden.
v3.12.x ist etwas Besonderes in dem Sinne, dass es den alten statischen Website -Generator verwendet. Dieser wird von GitHub -Aktionen für einen Cloudflare -Mitarbeiter bereitgestellt. Es ist unter https://v3-12.rabbitmq.com erhältlich.
Diese Website wurde mit Docusaurus 3 erstellt, einem modernen statischen Website -Generator.
Sie müssen JS -Komponenten installieren, die von Docusaurus zuerst mit yarn oder npm verwendet werden. Die folgenden Beispiele verwenden npm .
# for NPM users
npm installSie müssen das nur einmal de de eingehen.
Der folgende Befehl startet einen lokalen Entwicklungsserver und öffnet ein Standard -Browserfenster. Die meisten Änderungen werden live reflektiert, ohne den Server neu starten zu müssen.
npm start Um beispielsweise einen anderen Browser zu verwenden, stellen Sie die BROWSER -Env -Variable beim Ausführen npm start fest:
BROWSER= " Brave Beta " npm start Der folgende Befehl generiert statische Inhalte in das build -Verzeichnis und kann mit jedem Hosting -Service für statische Inhalte bedient werden.
npm run buildDies ist wichtig, um diesen Befehl auszuführen, bevor Sie Änderungen an GitHub drücken, um sicherzustellen, dass der Build erfolgreich ist. Dies ist der Befehl, mit dem die Website in der Produktion bereitgestellt wird.
© 2007-2024 Broadcom. Alle Rechte vorbehalten. Der Begriff "Broadcom" bezieht sich auf Broadcom Inc. und/oder seine Tochtergesellschaften.
Die RabbitMQ-Dokumentation ist unter der Apache-Lizenz 2.0 und der Mozilla Public License 2.0 doppelt lizenziert. Benutzer können eine dieser Lizenzen entsprechend ihren Bedürfnissen auswählen. Der Blog ist jedoch von dieser Lizenz ausgeschlossen und bleibt das geistige Eigentum von Broadcom Inc. -Blog -Posts möglicherweise nicht eingeschränkt.
SPDX-Lizenz-Identifikator: Apache-2.0 oder MPL-2.0
