Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- Apache Cassandra
- Escritor técnico:
- vohra
- 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
Un proyecto consta de los siguientes dos subproyectos:
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 de Apache Cassandra 4.0. Nuestro enfoque
propio para esto sería llamar primero a la lista de distribución
de Cassandra-dev para que los colaboradores de Cassandra destaquen las áreas del documento
que necesitan actualizaciones. En segundo lugar, realizaríamos una revisión estructurada
de la documentación existente para identificar posibles brechas. 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 encuentran en la fuente
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. Resuelve los tareas pendientes en la documentación de Apache Cassandra.
La documentación de Apache Cassandra contiene una serie de secciones
destacadas como "TODO" (o tareas que aún no se completaron). que son los siguientes:
- Cassandra o copias de seguridad operativos
- Cassandra operativo / carga masiva
- CQL / 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
- Cassandra/pistas de operación
- Descripción general o arquitectura (se propone como un proyecto independiente)
- Reparación de Cassandra/lectura de operación
- Muchos miembros de la comunidad produjeron material para cubrir 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 sintetizarlos en un documento conciso del conjunto de documentación de Apache Cassandra.