Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Apache Cassandra
- Technischer Redakteur:
- Dvohra
- Projektname:
- Dokumentation für Apache Cassandra 4.0 aktualisieren und Aufgaben in der Dokumentation beheben
- Projektdauer:
- Langfristig (5 Monate)
Projektbeschreibung
Das Projekt besteht aus zwei Unterprojekten:
1. Aktualisierung der Dokumentation zu Apache Cassandra 4.0
Prüfen und aktualisieren Sie die vorhandene Apache Cassandra-Dokumentation, um sicherzustellen, dass sie
mit dem kommenden Apache Cassandra 4.0-Release übereinstimmt. Unser vorgeschlagener
Ansatz hierfür bestand darin, zuerst einen Aufruf an die Mailingliste „cassandra-dev“
für Cassandra-Beitragende zu senden, um Bereiche des Dokuments hervorzuheben,
die aktualisiert werden müssen. Zweitens würden wir eine strukturierte
Überprüfung der vorhandenen Dokumentation erstellen, um potenzielle Lücken zu identifizieren. Beispiel:
In der strukturierten Überprüfung könnte der technische Redakteur die
Dokumentation zur Cassandra-Konfigurationsdatei
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html) mit den Konfigurationsoptionen vergleichen, die tatsächlich in der Quelle enthalten sind
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Aufgaben in der Apache Cassandra-Dokumentation auflösen
Die Apache Cassandra-Dokumentation enthält eine Reihe von Abschnitten,
die als „TODO“ (oder noch nicht abgeschlossene Aufgaben) markiert sind. Diese sind:
- Betrieb von Cassandra / Sicherungen
- Cassandra-Betrieb / Massenladevorgänge
- CQL / Datendefinitionen (eingeschränkte Prüfpunkte)
- Datenmodellierung
- Dynamo / Klatsch, Fehlererkennung und Token Ring
- Architektur/Garantien
- Betriebs-Cassandra/Hints
- Architektur/Übersicht (wird als separates Projekt vorgeschlagen)
- Cassandra-/Lese-Reparatur
- Viele Mitglieder der Community haben Material zu diesen Themen erstellt (einschließlich öffentlicher Blog-Posts, Stack Overflow-Beiträge usw.). Der produktivste Ansatz zum Ausfüllen dieser Abschnitte besteht möglicherweise darin, gute Referenzen und Material von den Mailinglisten anzufordern und in ein prägnantes Dokument der Apache Cassandra-Dokumentation zu synthetisieren.