Proyecto de Apache Cassandra
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
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.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-25 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Falta la información que necesito","missingTheInformationINeed","thumb-down"],["Muy complicado o demasiados pasos","tooComplicatedTooManySteps","thumb-down"],["Desactualizado","outOfDate","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Problema con las muestras o los códigos","samplesCodeIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-07-25 (UTC)"],[[["\u003cp\u003eThis project focuses on updating the Apache Cassandra documentation to align with the upcoming 4.0 release and addressing outstanding TODOs within the existing documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe project will involve community collaboration to identify areas needing updates and a structured review to ensure comprehensive coverage of features like configuration options.\u003c/p\u003e\n"],["\u003cp\u003eResolving documentation TODOs will entail leveraging existing community resources such as blog posts and Stack Overflow discussions to create concise and informative content.\u003c/p\u003e\n"],["\u003cp\u003eThe project aims to enhance the clarity and completeness of Apache Cassandra documentation, benefiting both new and experienced users.\u003c/p\u003e\n"]]],["The project involves two main tasks: updating Apache Cassandra documentation for the 4.0 release and resolving \"TODO\" sections within the existing documentation. The update will be achieved by soliciting feedback from Cassandra contributors and conducting a structured review of existing documentation, including comparing configuration file documentation with source code. Addressing \"TODOs\" will involve gathering community-sourced material from mailing lists and other sources to complete incomplete documentation sections, such as \"Backups\" and \"Data Modeling.\"\n"],null,["# Apache Cassandra project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: Apache Cassandra\n\nTechnical writer:\n: dvohra\n\nProject name:\n: Apache Cassandra 4.0 Documentation Update, and Resolve TODOs in Documentation\n\nProject length:\n: Long running (5 months)\n\nProject description\n-------------------\n\nProject consists of two sub-projects as follows:\n\n### 1. Apache Cassandra 4.0 Documentation Update\n\nReview and update existing Apache Cassandra documentation to ensure that it \n\nis aligned with the forthcoming Apache Cassandra 4.0 release. Our proposed \n\napproach to this would be to first put out a call to the cassandra-dev \n\nmailing list for Cassandra contributors to highlight areas of the document \n\nwhich are in need of updates. Secondly, we would put together a structured \n\nreview of the existing documentation to identify potential gaps. For \n\nexample: in the structured review, the technical writer could compare the \n\nCassandra configuration file documentation \n\n(\u003chttp://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html\u003e)\nwith the configuration options actually contained in the source \n\n(\u003chttps://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java\u003e).\n\n### 2. Resolve TODOs in Apache Cassandra Documentation\n\nThe Apache Cassandra documentation contains a number of sections \n\nhighlighted as \"TODO\" (or tasks yet to be completed). These are:\n\n- Operating Cassandra / Backups\n- Operating Cassandra / Bulk Loading\n- CQL / Data Definitions (limited review points)\n- Data Modelling\n- Dynamo / Gossip, Failure Detection and Token Ring\n- Architecture/Guarantees\n- Operating Cassandra/Hints\n- Architecture/Overview (this is proposed as a separate project)\n- Operating Cassandra/Read Repair\n- Many members of the community have produced material to cover these topics (including public blog posts, Stack Overflow posts, etc). The most productive approach to completing these sections may be to request good references and material from the mailing lists and synthesize into a concise document of the Apache Cassandra documentation set."]]
