“Documentation allows you to transfer the why behind code. Much in the same way code comments explain the why, and not the how, documentation serves the same purpose” - Write the Docs.
Halaman ini berisi hal-hal yang perlu diketahui dalam berkontribusi dalam dokumentasi. Dokumentasi merupakan bagian penting dalam proyek ini. Jadi, kami tunggu kontribusinya. 🙏
Proyek hidrokit (dan hidrokit-nb) memiliki berbagai jenis dokumentasi antara lain:
- Github community health file: dokumentasi yang digunakan untuk Github menyampaikan informasi berupa dokumen README, CONTRIBUTING, CODE_of_CONDUCT, Issue Template, dll. Jenis ini lebih fokus bagaimana interaksi yang terjadi saat menggunakan Github.
- Situs (hidrokit): dokumentasi ini membicarakan konten yang ada di situs proyek ini berupa halaman yang sedang anda baca, halaman tentang hidrokit, berkontribusi, dll. Dokumentasi situs lebih diutamakan karena target pengguna ataupun peminat bisa jadi tidak terbiasa dengan membaca dokumentasi melalui Github.
- Situs (hidrokit-nb): serupa dengan nomor 2, akan tetapi proyek yang dimaksud adalah proyek hidrokit-nb (Hidrokit Notebook).
- readthedocs / API (Python): dokumentasi teknis berbahasa inggris yang dibuat berdasarkan docstring dalam kode python. Dokumentasi ini ditujukan untuk pengembangan kode python.
DAFTAR ISI
Bentuk kontribusi
Bentuk kontribusi dalam dokumentasi bisa berupa:
- Ide dokumentasi (ide tutorial)
- Mengoreksi tulisan (ejaan, kalimat, bahasa)
- Format penulisan (tebal, miring,
kode) - Memperbaiki struktur dokumen (outline, bab)
- Memperjelas bahasa dan penyampaian
- Menerjemahkan dokumen
Yang dipersiapkan
Dalam memulai kontribusi dibutuhkan:
- Memahami struktur proyek (struktur direktori dan files). Baca struktur proyek.
- Melakukan pull request.
- Menggunakan markdown.
Cara berkontribusi
Untuk perubahan kecil seperti mengoreksi ejaan dapat dilakukan melalui tampilan Github. Untuk perubahan yang membutuhkan tahap uji coba (testing) dianjurkan untuk membuat environment dokumentasinya. Dokumentasi situs (hidrokit/hidrokit-nb) telah menggunakan Continous Integration travis-ci sehingga setiap pull request akan diperiksa kondisi build-nya, yang artinya Anda tidak akan direpotkan untuk mengujinya jika Anda tidak bisa memasang environment-nya.
Panduan berdokumentasi
Berikut panduan dokumentasi yang digunakan sebagai acuan di proyek ini:
Nemu yang keliru di dokumen? 😳 Gak usah ragu buat isu / PR 🦹♀️🦹♂️