Esta página contém os detalhes de um projeto de escrita 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 (link em inglês)
- Nome do projeto:
- Atualização da documentação do Apache Cassandra 4.0 e "Resolver 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 forma:
1. Atualização da documentação do Apache Cassandra 4.0
Revise e atualize a documentação do Apache Cassandra para garantir que ela
esteja alinhada à futura versão 4.0 do Apache Cassandra. Nossa abordagem
proposta para isso seria primeiro ligar para a lista de e-mails
cassandra-dev para os colaboradores do Cassandra destacarem áreas do documento
que precisam de atualizações. Em segundo lugar, organizamos 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 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 pendentes na documentação do Apache Cassandra
A documentação do Apache Cassandra contém várias seções
destacadas como "TODO" (ou tarefas ainda a serem 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
- Dínamo / fofoca, detecção de falhas e token Ring
- Arquitetura/Garantias
- Cassandra operacional/Dicas
- Arquitetura/visão geral (proposto como um projeto separado)
- Reparo de leitura/Cassandra operacional
- Muitos membros da comunidade produziram material sobre 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 e-mails e sintetizar em um documento conciso do conjunto de documentação do Apache Cassandra.