Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione di Documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Apache Cassandra
- Redattore tecnico:
- Dvohra
- Nome del progetto:
- Aggiornamento della documentazione di Apache Cassandra 4.0 e risoluzione delle attività nella documentazione
- Durata del progetto:
- A lungo termine (5 mesi)
Project description
Il progetto è costituito da due sottoprogetti come segue:
1. Aggiornamento della documentazione di Apache Cassandra 4.0
Esamina e aggiorna la documentazione esistente di Apache Cassandra per assicurarti che
sia in linea con la prossima release di Apache Cassandra 4.0. Il nostro approccio
proposto a questo problema sarebbe innanzitutto inviare una chiamata alla mailing list cassandra-dev
per chiedere ai collaboratori di Cassandra di evidenziare le aree del documento
che richiedono aggiornamenti. In secondo luogo, effettueremo un
esame strutturato della documentazione esistente per identificare potenziali lacune. Ad
esempio: nella revisione strutturata, il tecnico redattore potrebbe confrontare la
documentazione del file di configurazione di Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
con le opzioni di configurazione effettivamente contenute nel codice sorgente
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
2. Risolvere i TODO nella documentazione di Apache Cassandra
La documentazione di Apache Cassandra contiene una serie di sezioni
evidenziate come "DA FARE" (o attività da completare). Queste sono:
- Utilizzo di Cassandra / backup
- Utilizzo di Cassandra / caricamento collettivo
- CQL / definizioni dei dati (punti di revisione limitati)
- Modellazione dei dati
- Dynamo / Gossip, Failure Detection e Token Ring
- Architettura/garanzie
- Utilizzo di Cassandra/Hint
- Architettura/Panoramica (questo è proposto come progetto separato)
- Utilizzo di Cassandra/Read Repair
- Molti membri della community hanno prodotto materiale per trattare questi argomenti (compresi post di blog pubblici, post di Stack Overflow ecc.). L'approccio più produttivo per completare queste sezioni può essere richiedere riferimenti e materiali validi dalle mailing list e sintetizzarli in un documento conciso del set di documentazione di Apache Cassandra.