Esta página contém os detalhes de um projeto de redação técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Apache Cassandra
- Redator técnico:
- Dvohra
- Nome do projeto:
- Atualização da documentação do Apache Cassandra 4.0 e resolva as tarefas pendentes na documentação
- Duração do projeto:
- De longa duração (5 meses)
Project description
O projeto consiste em dois subprojetos, da seguinte maneira:
1. Atualização da documentação do Apache Cassandra 4.0
Revise e atualize a documentação atual do Apache Cassandra para garantir que ela
esteja alinhada à próxima versão do Apache Cassandra 4.0. Nossa
abordagem para isso seria chamar primeiro a lista de e-mails
cassandra-dev para os colaboradores do Cassandra destacarem as áreas do documento
que precisam de atualizações. Em segundo lugar, elaboramos uma revisão
estruturada da documentação atual para identificar possíveis lacunas. Por
exemplo: na revisão estruturada, o redator técnico pode comparar a
documentação do arquivo de configuração do Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
com as opções de configuração que realmente estão contidas na origem
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Resolver tarefas na documentação do Apache Cassandra
A documentação do Apache Cassandra contém várias seções
destacadas como "TODO" (ou tarefas que ainda não foram concluídas). São estes:
- Cassandra operacional / backups
- Cassandra operacional / carregamento em massa
- CQL / definições de dados (pontos de revisão limitados)
- Modelagem de dados
- Dynamo / Fofoca, Detecção de Falhas e Token Ring
- Arquitetura/Garantias
- Cassandra/Dicas operacionais
- Arquitetura/Visão geral (proposto como um projeto separado)
- Reparo de leitura/Cassandra operacional
- Muitos membros da comunidade produziram materiais para abordar esses tópicos, incluindo postagens de blogs públicos, do Stack Overflow etc. A abordagem mais produtiva para completar essas seções pode ser solicitar boas referências e materiais das listas de discussão e sintetizar em um documento conciso do conjunto de documentação do Apache Cassandra.