Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Apache Cassandra (em inglês)
- Redator técnico:
- dvohra
- Nome do projeto:
- Atualização da documentação do Apache Cassandra 4.0 e resolução de TODOS na documentação
- Duração do projeto:
- Longa duração (cinco meses)
Project description
O projeto consiste em dois subprojetos, conforme abaixo:
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 com a próxima versão do Apache Cassandra 4.0. Nossa proposta
seria fazer uma chamada para a lista de discussão cassandra-dev
para que os colaboradores do Cassandra destaquem as áreas do documento
que precisam de atualizações. Em segundo lugar, faríamos uma revisão
estruturada da documentação existente 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 realmente contidas na fonte
(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
realçadas como "TODO" (ou tarefas a serem concluídas). São eles:
- Como operar o Cassandra / Backups
- Como operar o Cassandra / carregamento em massa
- CQL / definições de dados (pontos de revisão limitados)
- Modelagem de dados
- Dynamo / Gossip, detecção de falhas e anel de token
- Arquitetura/garantias
- Como usar o Cassandra/Hints
- Arquitetura/visão geral (proposta como um projeto separado)
- Cassandra operacional/reparo de leitura
- Muitos membros da comunidade produziram material para abordar esses tópicos, incluindo postagens públicas no blog, postagens no Stack Overflow etc. A abordagem mais produtiva para completar essas seções pode ser solicitar boas referências e material das listas de distribuição e sintetizar em um documento conciso do conjunto de documentação do Apache Cassandra.