Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Apache Cassandra
- Penulis teknis:
- dvohra
- Nama project:
- Update Dokumentasi Apache Cassandra 4.0, dan Menyelesaikan TODO dalam Dokumentasi
- Durasi project:
- Berjalan lama (5 bulan)
Project description
Project terdiri dari dua sub-project sebagai berikut:
1. Pembaruan Dokumentasi Apache Cassandra 4.0
Tinjau dan perbarui dokumentasi Apache Cassandra yang ada untuk memastikan bahwa dokumentasi tersebut
selaras dengan rilis Apache Cassandra 4.0 mendatang. Pendekatan
yang kami usulkan untuk hal ini adalah dengan terlebih dahulu mengirimkan permintaan ke milis cassandra-dev
untuk meminta kontributor Cassandra menyoroti area dokumen
yang perlu diperbarui. Kedua, kami akan menyusun peninjauan
terstruktur terhadap dokumentasi yang ada untuk mengidentifikasi potensi kesenjangan. Misalnya, dalam peninjauan terstruktur, penulis teknis dapat membandingkan dokumentasi file konfigurasi Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
dengan opsi konfigurasi yang sebenarnya terdapat dalam sumber
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
2. Menyelesaikan TODO di Dokumentasi Apache Cassandra
Dokumentasi Apache Cassandra berisi sejumlah bagian
yang ditandai sebagai "TODO" (atau tugas yang belum selesai). Karakter pengganti ini meliputi:
- Mengoperasikan Cassandra / Pencadangan
- Mengoperasikan Cassandra / Pemuatan Massal
- CQL / Definisi Data (poin peninjauan terbatas)
- Pemodelan Data
- Dynamo / Gossip, Deteksi Kegagalan, dan Token Ring
- Arsitektur/Jaminan
- Mengoperasikan Cassandra/Petunjuk
- Arsitektur/Ringkasan (ini diusulkan sebagai project terpisah)
- Mengoperasikan Cassandra/Perbaikan Baca
- Banyak anggota komunitas telah membuat materi untuk membahas topik ini (termasuk postingan blog publik, postingan Stack Overflow, dll.). Pendekatan yang paling produktif untuk menyelesaikan bagian ini adalah dengan meminta referensi dan materi yang baik dari milis dan menyintesisnya menjadi dokumen ringkas dari kumpulan dokumentasi Apache Cassandra.