Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Apache Cassandra
- Pisarz techniczny:
- dvohra
- Nazwa projektu:
- Aktualizacja dokumentacji Apache Cassandra 4.0 i rozwiązanie wszystkich TODO w dokumentacji
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Projekt składa się z 2 takich podprojektów:
1. Aktualizacja dokumentacji programu Apache Cassandra 4.0
Sprawdź i zaktualizuj istniejącą dokumentację Apache Cassandra, aby upewnić się, że
jest ona zgodna z nadchodzącą wersją Apache Cassandra 4.0. Proponujemy
, aby najpierw wysłać wiadomość do listy mailingowej cassandra-dev
, na której znajdują się osoby współpracujące przy Cassandra, aby wskazać obszary dokumentu
, które wymagają aktualizacji. Po drugie, przeprowadzimy ustrukturyzowany
przegląd istniejących dokumentów, aby zidentyfikować potencjalne luki. Na
http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.htmlhttps://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Rozwiązywanie TODO w dokumentacji Apache Cassandra
Dokumentacja Apache Cassandra zawiera kilka sekcji
wyróżnionych jako „TODO” (lub zadań, które nie zostały jeszcze ukończone). Dostępne symbole:
- Obsługiwanie Cassandra / kopii zapasowych
- Obsługa Cassandra / wczytywanie zbiorcze
- CQL / definicje danych (ograniczone punkty weryfikacji)
- Modelowanie danych
- Dynamo / Plotki, Wykrywanie awarii i Token Ring
- Architektura/Gwarancje
- Obsługa Cassandra/Wskazówki
- Architektura/Przegląd (to jest proponowany oddzielny projekt)
- Obsługa systemu Cassandra/odczyt
- Wielu członków społeczności przygotowało materiały dotyczące tych tematów (w tym publiczne posty na blogach, posty na Stack Overflow itp.). Najbardziej efektywnym sposobem na wypełnienie tych sekcji może być poproszenie o dobre materiały i dokumenty odnoszące się do list mailingowych oraz ich syntezę w zwięzłym dokumencie z dokumentacji Apache Cassandra.