Repositori ini adalah sumber utama dokumentasi pengembang untuk Flatpak. Dapat dibaca di docs.flatpak.org.
Beberapa dokumentasi juga tersedia di wiki Flatpak dan sebagai bagian dari halaman manual pembuat flatpak dan flatpak-builder .
Dokumen ditulis dalam reStructuredText dan kontribusi dipersilakan!
Buat lingkungan virtual Python:
python3 -m venv .venv && sumber .venv/bin/aktifkan
Kemudian instal dependensi dengan pip :
instalasi pip -r persyaratan.txt
Setelah penyiapan, Anda dapat membuat dokumentasi:
buat -C dokumen html
Jalankan tes:
buat pemeriksaan tautan dokumen -C
Anda dapat menjalankan server HTTP dan mengikuti tautan tercetak (localhost:8000) untuk melihat dokumentasi di browser Anda:
python3 -m http.server -d dokumen/_build/html
Secara default, dokumen yang dibuat dalam bahasa Inggris. Jika Anda ingin membuat dokumen dalam bahasa lain, seperti bahasa Mandarin, Anda dapat menggunakan perintah berikut:
buat -C dokumen html SPHINXOPTS='-D bahasa=zh_CN'
Anda dapat membuka permintaan tarik dengan menambahkan bahasa baru.
Pengelola dapat membuat file templat ( .pot ), memperbarui file terjemahan ( .po ) dan menghapus file terjemahan yang sudah usang (yaitu file .pot yang cocok sudah tidak ada lagi) dengan menjalankan:
buat -C pembaruan dokumen-po
Pengembang aplikasi desktop adalah audiens utama dokumen Flatpak, khususnya pembuat aplikasi yang sudah ada, termasuk yang berasal dari platform non-Linux.
Dokumen tersebut harus mencerminkan praktik populer di kalangan audiens ini sedapat mungkin dan tidak berasumsi bahwa aplikasi berasal dari ruang desktop Linux. Secara praktis, ini berarti kita harus mengharapkan:
.desktop , AppStream, dan D-BusDi luar standar dasar ini, perhatian khusus harus diberikan pada teknologi lintas platform populer seperti Electron dan Qt.
Pedoman bagi mereka yang ingin berkontribusi pada dokumen:
