Cette page contient les détails d'un projet de rédaction technique accepté pour la 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 à faire dans la documentation
- Durée du projet:
- Longue durée (5 mois)
Project description
Le projet se compose de deux sous-projets, comme suit:
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 en conformité avec la prochaine version Apache Cassandra 4.0.
Notre approche proposée
consisterait à lancer 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. Deuxièmement, nous allons procéder à un examen structuré
de la documentation existante afin d'identifier les lacunes potentielles. Par exemple, dans l'examen structuré, l'auteur technique peut comparer la documentation du fichier de configuration Cassandra (http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html) aux 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. Résoudre les tâches à faire dans la documentation Apache Cassandra
La documentation Apache Cassandra contient un certain nombre de sections
soulignées comme "TODO" (ou tâches à accomplir). Les voici :
- Fonctionnement de Cassandra / Sauvegardes
- Fonctionnement de Cassandra / Chargement par lot
- CQL / Définitions de données (points d'examen limités)
- Modélisation des données
- Dynamo / Rugby, détection des défaillances et échange de jetons
- Architecture/Garanties
- Fonctionnement de Cassandra/Conseils
- Architecture/Présentation (proposé comme projet distinct)
- Fonctionnement de Cassandra/réparation de lecture
- De nombreux membres de la communauté ont produit des contenus sur ces sujets (y compris des articles de blog publics, des posts sur Stack Overflow, etc.). La méthode la plus productive pour remplir ces sections consiste peut-être à demander de bonnes références et des documents sur les listes de diffusion, puis à les synthétiser dans un document concis de l'ensemble de documentation Apache Cassandra.