Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Apache Cassandra
- Technical writer:
- Dvohra
- Nome progetto:
- Aggiornamento della documentazione di Apache Cassandra 4.0 e risoluzione dei passaggi nella documentazione
- Durata del progetto:
- Lunga esecuzione (5 mesi)
Project description
Il progetto è costituito da due progetti secondari:
1. Aggiornamento della documentazione di Apache Cassandra 4.0
Rivedi 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 scopo sarebbe innanzitutto avviare una chiamata alla mailing list cassandra-dev
per consentire ai collaboratori di Cassandra di evidenziare aree del documento
che necessitano di aggiornamenti. In secondo luogo, avremmo elaborato una revisione
strutturata della documentazione esistente per identificare potenziali lacune. Ad
esempio: nella revisione strutturata, il Technical Writer può confrontare la
documentazione relativa al file di configurazione Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
con le opzioni di configurazione effettivamente contenute nell'origine
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java).
2. Risolvi le attività nella documentazione di Apache Cassandra
La documentazione di Apache Cassandra contiene una serie di sezioni
evidenziate come "DA FARE" (o attività ancora da completare). Le tre aree sono:
- Funzionamento di Cassandra / backup
- Funzionamento di Cassandra / caricamento collettivo
- CQL / Definizioni dei dati (punti di revisione limitati)
- Modellazione dei dati
- Dinamo / gossip, rilevamento di errori e token Ring
- Architettura/Garanzie
- Uso di Cassandra/Suggerimenti
- Architettura/Panoramica (proposta come progetto separato)
- Uso di Cassandra/Riparazione lettura
- Molti membri della community hanno realizzato materiale per trattare questi argomenti (inclusi post di blog pubblici, post di Stack Overflow e così via). L'approccio più produttivo per completare queste sezioni può essere richiedere buoni riferimenti e materiale dalle mailing list e sintetizzarli in un documento conciso della documentazione di Apache Cassandra.