Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Apache Cassandra
- Pisarz techniczny:
- Dvohra
- Nazwa projektu:
- Aktualizacja dokumentacji Apache Cassandra 4.0 i rozwiązywanie zadań do wykonania w dokumentacji
- Długość projektu:
- Długotrwałe (5 miesięcy)
Opis projektu
Projekt składa się z dwóch następujących podprojektów:
1. Aktualizacja dokumentacji Apache Cassandra 4.0
Przejrzyj i zaktualizuj dotychczasową dokumentację Apache Cassandra,
aby była zgodna z nadchodzącą wersją Apache Cassandra 4.0. Nasze rozwiązanie
to najpierw nawiązanie do listy adresowej cassandra-dev
z myślą o wyróżnieniu obszarów dokumentu,
które wymagają aktualizacji. W drugim przypadku przeprowadzimy ustrukturyzowaną
dokumentację, która pozwoli nam zidentyfikować potencjalne luki. Na
przykład: w ramach weryfikacji ustrukturyzowanej autor może porównać
dokumentację pliku konfiguracyjnego Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html) z opcjami konfiguracji zawartymi w źródle
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Rozwiąż zadania do wykonania w dokumentacji Apache Cassandra
Dokumentacja Apache Cassandra zawiera kilka sekcji,
które są oznaczone jako „TODO” (czyli zadania, które nie zostały jeszcze ukończone). Dostępne symbole:
- Obsługa systemu Cassandra / kopie zapasowe
- Obsługa Cassandra / ładowanie zbiorcze
- CQL / definicje danych (ograniczona liczba punktów weryfikacji)
- Modelowanie danych
- Dynamo / plotki, wykrywanie awarii i dzwonienie tokenów
- Architektura/gwarancje
- Obsługa Cassandra/wskazówki
- Architektura/Przegląd (propozycja jest proponowana jako oddzielny projekt)
- Obsługa systemu Cassandra/naprawa odczytu
- Wielu członków społeczności opracowało materiały na te tematy (w tym posty na publicznych blogach, posty na stronie Stack Overflow itp.). Najbardziej produktywnym podejściem do wypełniania tych sekcji może być prośba o dobre źródła i materiały z list adresowych oraz stworzenie zwięzłego dokumentu z zestawem dokumentacji Apache Cassandra.