Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Apache Cassandra
- Teknik yazar:
- dvohra
- Proje adı:
- Apache Cassandra 4.0 Doküman Güncellemesi ve Dokümanda TODO'ların Çözümü
- Proje uzunluğu:
- Uzun süreli (5 ay)
Proje açıklaması
Proje aşağıdaki iki alt projeden oluşur:
1. Apache Cassandra 4.0 Doküman Güncellemesi
Mevcut Apache Cassandra belgelerini inceleyip yaklaşan Apache Cassandra 4.0 sürümüne uygun olacak şekilde güncelleyin.
Bu konuyla ilgili olarak önerdiğimiz yaklaşım, öncelikle Cassandra katkıda bulunanların, belgenin güncellenmesi gereken alanlarını vurgulamaları için cassandra-dev posta listesine bir çağrı göndermektir.
İkinci olarak, olası boşlukları tespit etmek için mevcut dokümanları yapılandırılmış bir şekilde inceleriz.
Örneğin,
yapılandırılmış incelemede teknik yazar,
Cassandra yapılandırma dosyası dokümanlarını
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
aslında kaynakta yer alan yapılandırma seçenekleriyle
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Apache Cassandra Belgelerindeki TODO'ları çözme
Apache Cassandra dokümanlarında, "TODO" (veya henüz tamamlanmamış görevler) olarak vurgulanmış bir dizi bölüm bulunur.
Desteklenen biçimler şunlardır:
- Cassandra'yı çalıştırma / Yedekleme
- Cassandra'yı Çalıştırma / Toplu Yükleme
- CQL / Veri Tanımları (sınırlı inceleme puanları)
- Veri Modelleme
- Dynamo / Gossip, Hata Algılama ve Jeton Halkası
- Mimari/Garantiler
- Cassandra'yı çalıştırma/İpuçları
- Mimari/Genel Bakış (bu, ayrı bir proje olarak önerilir)
- Cassandra/Read Repair'i çalıştırma
- Topluluğun pek çok üyesi bu konuları ele alan materyaller oluşturdu (herkese açık blog yayınları, Stack Overflow yayınları vb. dahil). Bu bölümleri tamamlamanın en verimli yolu, posta listelerinden iyi referanslar ve materyaller istemek ve bunları Apache Cassandra doküman setinin kısa bir belgesinde sentezlemek olabilir.