Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Apache Cassandra
- Escritor técnico:
- dvohra
- Nombre del proyecto:
- Actualización de la documentación de Apache Cassandra 4.0 y resolución de tareas pendientes en la documentación
- Duración del proyecto:
- Larga duración (5 meses)
Project description
El proyecto consta de dos subproyectos, como se indica a continuación:
1. Actualización de la documentación de Apache Cassandra 4.0
Revisa y actualiza la documentación existente de Apache Cassandra para asegurarte de que
esté alineada con la próxima versión 4.0 de Apache Cassandra. Nuestro enfoque
propuesto para esto sería, primero, hacer una llamada a la lista de distribución cassandra-dev
para que los colaboradores de Cassandra destaquen las áreas del documento
que necesitan actualizaciones. En segundo lugar, elaboraríamos una revisión
estructurada de la documentación existente para identificar posibles carencias. Por
ejemplo: en la revisión estructurada, el escritor técnico podría comparar la
documentación del archivo de configuración de Cassandra
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
con las opciones de configuración que realmente se incluyen en la fuente
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Soluciona las tareas pendientes en la documentación de Apache Cassandra
La documentación de Apache Cassandra contiene varias secciones
destacadas como “TODO” (o tareas que aún no se completan). Debes realizar las siguientes acciones:
- Operación de Cassandra / copias de seguridad
- Operación de Cassandra o carga masiva
- CQL o definiciones de datos (puntos de revisión limitados)
- Modelado de datos
- Dínamo / chismes, detección de fallas y anillo de tokens
- Arquitectura/garantías
- Operación de Cassandra/sugerencias
- Arquitectura/descripción general (se propone como un proyecto independiente)
- Cómo operar Cassandra/Read Repair
- Muchos miembros de la comunidad han producido material para abordar estos temas (incluidas entradas de blog públicas, publicaciones de Stack Overflow, etc.). El enfoque más productivo para completar estas secciones puede ser solicitar buenas referencias y material de las listas de distribución y sintetizarlas en un documento conciso del conjunto de documentación de Apache Cassandra.