Sempurnakan panduan ini¶
Manual ini disimpan sebagai Markdown di direktori docs/ dan dibuat dengan MkDocs.
Pratinjau lokal¶
Buat lingkungan virtual dan instal dependensi dokumentasi:
python3 -m venv .venv
. .venv/bin/activate
pip install --requirement requirements-docs.txt
mkdocs serve
Buka alamat lokal yang dicetak oleh MkDocs. Pratinjau dibangun kembali ketika file sumber berubah.
Validasi situs¶
Sebelum membuka pull request:
Laporan build yang ketat tidak berisi entri navigasi, tautan tidak valid yang terdeteksi oleh MkDocs, dan peringatan konfigurasi.
Prinsip menulis¶
- Menulis untuk tugas dan audiens tertentu.
- Nyatakan versi MRBS jika perilakunya spesifik untuk rilis.
- Lebih suka contoh yang diuji daripada daftar yang lengkap.
- Jangan pernah menyertakan kredensial asli atau data pemesanan pribadi.
- Tautkan tugas terkait alih-alih menduplikasi bagian besar.
- Perbarui semua terjemahan yang tersedia bila memungkinkan.
Terjemahan¶
Bahasa Inggris adalah teks acuan. Halaman terjemahan menggunakan jalur relatif yang sama dengan sufiks bahasa:
Jika terjemahannya hilang, situs akan kembali ke bahasa Inggris. Terjemahan harus mempertahankan kode, menetapkan nama, peringatan, dan tautan sambil menggunakan terminologi alami dalam bahasa target.
Cakupan¶
Pohon dokumentasi ini menargetkan MRBS 1.12.2. Perubahan yang menjelaskan rilis selanjutnya harus memperbarui cakupan versi yang terlihat atau dikembangkan dalam kumpulan dokumentasi untuk rilis tersebut.