Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Apache Cassandra
- Rédacteur technique:
- Dvohra
- Nom du projet:
- Mise à jour de la documentation Apache Cassandra 4.0 et résolution des tâches à effectuer dans la documentation
- Durée du projet:
- Exécution de longue durée (5 mois)
Project description
Le projet comprend deux sous-projets:
1. Mise à jour de la documentation Apache Cassandra 4.0
Examinez et mettez à jour la documentation Apache Cassandra existante pour vous assurer qu'elle
est conforme à la version d'Apache Cassandra 4.0 à venir. L'approche
que nous proposons consisterait à envoyer d'abord un appel à la liste de diffusion cassandra-dev
pour que les contributeurs Cassandra mettent en évidence les parties du document qui doivent être mises à jour.
Ensuite, nous élaborerions un examen
structuré de la documentation existante afin d'identifier les lacunes potentielles. Par
exemple: dans l'examen structuré, le rédacteur technique peut comparer la
documentation du fichier de configuration Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
avec les options de configuration réellement contenues dans la source
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Documentation sur la résolution des tâches à effectuer dans Apache Cassandra
La documentation Apache Cassandra contient un certain nombre de sections
mises en surbrillance comme "TODO" (ou tâches à terminer). Les voici :
- Fonctionnement de Cassandra / Sauvegardes
- Fonctionnement de Cassandra / Chargement groupé
- CQL / Définitions de données (points à examiner limité)
- Modélisation des données
- Dynamo / Gossip, détection d'échecs et Token Ring
- Architecture/Garanties
- Utiliser Cassandra/Hints
- Architecture/Présentation (proposé en tant que projet distinct)
- Utiliser Cassandra/Read Repair
- De nombreux membres de la communauté ont produit des documents pour couvrir ces sujets (y compris des articles de blog publics, des articles de Stack Overflow, etc.). L'approche la plus efficace pour remplir ces sections peut consister à demander des références et des documents pertinents aux listes de diffusion, puis à les synthétiser dans un document concis constitué de l'ensemble de la documentation Apache Cassandra.