Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Apache Cassandra
- Technischer Redakteur:
- dvohra
- Projektname:
- Aktualisierung der Apache Cassandra 4.0-Dokumentation und Behebung von TODOs in der Dokumentation
- Projektdauer:
- Lang andauernd (5 Monate)
Projektbeschreibung
Das Projekt besteht aus zwei Teilprojekten:
1. Aktualisierung der Apache Cassandra 4.0-Dokumentation
Prüfen und aktualisieren Sie die vorhandene Apache Cassandra-Dokumentation, um sicherzustellen, dass sie
zur bevorstehenden Apache Cassandra-Version 4.0 passt. Wir schlagen vor,
zuerst die Cassandra-Entwickler über die cassandra-dev-Mailingliste
um Vorschläge zu bitten, welche Bereiche des Dokuments aktualisiert werden sollten.
Zweitens würden wir eine strukturierte
Überprüfung der vorhandenen Dokumentation durchführen, um potenzielle Lücken zu identifizieren. Beispiel: Bei der strukturierten Überprüfung könnte der Technische Redakteur die Dokumentation der 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. TODOs in der Apache Cassandra-Dokumentation beheben
Die Apache Cassandra-Dokumentation enthält eine Reihe von Abschnitten, die als „TODO“ (zu erledigende Aufgaben) hervorgehoben sind.
Diese sind:
- Cassandra / Sicherungen ausführen
- Cassandra-Betrieb / Bulk-Laden
- CQL / Datendefinitionen (eingeschränkte Prüfpunkte)
- Datenmodellierung
- Dynamo / Klatsch, Fehlererkennung und Token-Ring
- Architektur/Garantien
- Cassandra betreiben/Tipps
- Architektur/Übersicht (dies wird als separates Projekt vorgeschlagen)
- Cassandra/Read Repair verwenden
- Viele Mitglieder der Community haben Materialien zu diesen Themen erstellt, darunter öffentliche Blogbeiträge und Stack Overflow-Beiträge. Der produktivste Ansatz zum Ausfüllen dieser Abschnitte besteht darin, gute Referenzen und Materialien aus den Mailinglisten anzufordern und in einem kompakten Dokument der Apache Cassandra-Dokumentation zusammenzufassen.