rabbitmq website

Situs web

Repositori ini berisi kode sumber situs web RabbitMQ, rabbitmq.com. Pastikan untuk membaca bagian alur kerja sebelum berkontribusi .

Alur kerja

Tl; dr

Berikut adalah ringkasan versi dokumentasi mana yang sesuai dengan cabang dan direktori mana:

Versi RabbitMQ	Cabang	Sub-direktori	Dilayani di
Versi Pengembangan (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	akar	v3-12.rabbitmq.com

Cabang dan Versi

Cabang main adalah cabang produksi. Komit untuk itu digunakan secara otomatis ke www.rabbitmq.com oleh pekerja cloudflare.

Kami menyimpan beberapa versi dokumen di cabang main . Docusaurus menggunakan direktori berikut:

• docs berisi Docs of the Future Version RabbitMQ, jadi itu adalah pekerjaan yang sedang berlangsung. Disajikan di https://www.rabbitmq.com/docs/next.
• versioned_docs berisi satu direktori per versi; Misalnya, versioned_docs/version-4.0 . Versi terbaru disajikan di https://www.rabbitmq.com/docs. Versi yang lebih lama disajikan di …/docs/$version .

Perubahan harus dilakukan untuk docs dan versi apa pun yang mereka berlaku. Inilah contohnya:

 # 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

Silakan baca dokumentasi versi di Docusaurus untuk mempelajari lebih lanjut.

Versi yang lebih lama dari dokumen yang tidak ingin kami host di Docusaurus untuk membatasi jumlah versi dimasukkan ke dalam cabang dari bentuk v3.13.x , v4.0.x , dll. Cabang-cabang ini juga digunakan secara otomatis dan mereka menggunakan nama domain dari bentuk v3-13.rabbitmq.com , v4-0.rabbitmq.com , dll. Masing-masing. Perhatikan bahwa cabang -cabang ini digunakan sebagai contoh mungkin belum ada jika dokumen yang sesuai masih dipertahankan di cabang main .

v3.12.x sedikit istimewa dalam arti bahwa ia menggunakan generator situs web statis lama. Yang ini digunakan oleh tindakan gitub ke pekerja cloudflare. Ini tersedia di https://v3-12.rabbitmq.com.

Cara membangun

Situs web ini dibangun menggunakan Docusaurus 3, generator situs web statis modern.

Instalasi

Anda perlu menginstal komponen JS yang digunakan oleh Docusaurus terlebih dahulu dengan yarn atau npm . Contoh di bawah ini menggunakan npm .

 # for NPM users
npm install

Anda hanya perlu melakukan ini sekali saja.

Pengembangan Lokal

Perintah berikut memulai server pengembangan lokal dan membuka jendela browser default. Sebagian besar perubahan tercermin secara langsung tanpa harus memulai kembali server.

npm start

Untuk menggunakan browser yang berbeda, misalnya, beta berani, atur variabel BROWSER saat menjalankan npm start :

BROWSER= " Brave Beta " npm start

Membangun

Perintah berikut menghasilkan konten statis ke dalam direktori build dan dapat dilayani menggunakan layanan hosting konten statis apa pun.

npm run build

Ini penting untuk menjalankan perintah ini sebelum mendorong perubahan ke GitHub untuk memastikan bangunan berhasil. Ini adalah perintah yang akan digunakan untuk menggunakan situs web dalam produksi.

Hak Cipta dan Lisensi

© 2007-2024 Broadcom. Semua hak dilindungi undang -undang. Istilah "Broadcom" mengacu pada Broadcom Inc. dan/atau anak perusahaannya.

Dokumentasi RabbitMQ dilisensikan ganda di bawah Lisensi Apache 2.0 dan Lisensi Publik Mozilla 2.0. Pengguna dapat memilih salah satu lisensi ini sesuai dengan kebutuhan mereka. Namun, blog dikecualikan dari lisensi ini dan tetap menjadi properti intelektual dari posting blog Broadcom Inc. mungkin tidak dibatasi.

SPDX-LICENSE-Identifier: Apache-2.0 atau MPL-2.0