Dokumentasi¶

Bagian ini berisi informasi yang diperlukan untuk berkontribusi pada dokumentasi OpenStack.

Dokumen dalam repositori proyek¶

Semua dokumentasi proyek harus mengikuti struktur direktori yang sama, yang dijelaskan pada Project Guide Setup page.

Struktur direktori dokumentasi adalah sebagai berikut:

└── source
    ├── admin
    ├── cli
    ├── configuration
    ├── contributor
    ├── install
    ├── reference
    └── user

Panduan instalasi¶

Panduan instalasi dapat ditemukan di direktori install. Ini berisi informasi tentang apa saja yang harus dilakukan dengan menginstal proyek dari paket, misalnya, perangkat lunak yang diperlukan untuk menginstal proyek, seperti instalasi dan konfigurasi database, atau parameter apa yang harus ditetapkan dalam file konfigurasi proyek. Jika semuanya dikonfigurasi dengan benar (dijelaskan di bawah), panduan instalasi proyek termasuk dalam OpenStack Installation Guides. Panduan instalasi tidak dimaksudkan untuk digunakan untuk instalasi sistem produksi.

Panduan kontributor¶

Panduan kontributor dapat ditemukan di direktori contributor . Ini berisi informasi spesifik proyek tentang kontribusi pada proyek dan manajemen tim. Panduan ini hanya muncul dalam dokumentasi proyek.

Referensi konfigurasi¶

Direktori configuration berisi informasi referensi konfigurasi yang dihasilkan secara otomatis (jika proyek menggunakan oslo.config) atau ditulis secara manual (jika oslo.config tidak digunakan). Untuk informasi lebih lanjut, lihat Sphinx Integration.

Referensi CLI¶

Direktori cli berisi dokumentasi referensi alat baris perintah yang dapat dibuat secara otomatis dengan integrasi sphinx, atau ditulis secara manual ketika pembuatan otomatis tidak dimungkinkan. Untuk informasi lebih lanjut, lihat cliff Sphinx Integration.

Panduan administrator¶

Panduan admin dapat ditemukan di direktori admin. Ini berisi informasi tentang konfigurasi dan operasi perangkat lunak. Panduan administrator proyek termasuk dalam OpenStack Administrator Guides.

Panduan User¶

Direktori user berisi informasi yang ditargetkan pada pengguna akhir, misalnya, panduan konsep, tutorial, petunjuk langkah demi langkah untuk menggunakan CLI atau API proyek, dan semacamnya.

Dokumen referensi¶

Direktori reference berisi informasi referensi yang tidak termasuk dalam direktori lain, misalnya, dokumentasi kelas yang dibuat secara otomatis dalam proyek perpustakaan.

Menerbitkan dokumen dalam repositori proyek¶

Agar dokumen proyek dapat ditautkan pada OpenStack documentation portal, file www/project-data/latest.yaml dalam repositori openstack-manuals harus diperbarui, mengikuti aturan dari template generator.

Temukan proyek Anda di file.

Setel ke 'true' semua opsi dokumen yang berlaku. Sebagai contoh:

has_install_guide: true
has_api_ref: true
has_admin_guide: true
has_config_ref: true
has_user_guide: true

Jika struktur di atas ada dalam repositori proyek dan file latest.yaml diperbarui, pekerjaan publish-openstack-sphinx-docs dalam project-config repo secara otomatis menyertakan dokumen dalam dokumentasi yang diterbitkan. Untuk instruksi terperinci, lihat Project guide setup.

Dokumentasi