Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Apache Cassandra
- Penulis teknis:
- dvohra
- Nama proyek:
- Pembaruan Dokumentasi Apache Cassandra 4.0, dan Menyelesaikan TODO dalam Dokumentasi
- Durasi proyek:
- Jangka panjang (5 bulan)
Project description
Proyek terdiri dari dua sub-proyek sebagai berikut:
1. Pembaruan Dokumentasi Apache Cassandra 4.0
Tinjau dan perbarui dokumentasi Apache Cassandra yang ada untuk memastikannya
sesuai dengan rilis Apache Cassandra 4.0 yang akan datang. Pendekatan
kami yang kami usulkan adalah dengan terlebih dahulu melakukan panggilan ke milis cassandra-dev
bagi kontributor Cassandra untuk menyoroti area dokumen
yang perlu diperbarui. Kedua, kami akan menyusun tinjauan
terstruktur dari dokumentasi yang ada untuk mengidentifikasi potensi kesenjangan. Misalnya:
contoh: dalam ulasan 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 di sumber
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Menyelesaikan TODO dalam Dokumentasi Apache Cassandra
Dokumentasi Apache Cassandra berisi sejumlah bagian
yang ditandai sebagai "TODO" (atau tugas yang harus diselesaikan). Di antaranya:
- Mengoperasikan Cassandra / Cadangan
- Mengoperasikan Cassandra / Pemuatan Massal
- CQL / Definisi Data (poin peninjauan terbatas)
- Pemodelan Data
- Dinamo / Gosip, Deteksi Kegagalan dan Token Ring
- Arsitektur/Jaminan
- Mengoperasikan Cassandra/Petunjuk
- Arsitektur/Ringkasan (ini diusulkan sebagai project terpisah)
- Perbaikan Cassandra/Baca
- Banyak anggota komunitas telah menghasilkan materi untuk membahas topik ini (termasuk postingan blog publik, postingan Stack Overflow, dll). Pendekatan yang paling produktif untuk menyelesaikan bagian ini mungkin adalah meminta referensi dan materi yang baik dari milis serta merangkum kumpulan dokumentasi Apache Cassandra ke dalam bentuk dokumen yang ringkas.