Apache Cassandra 專案
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織:
- Apache Cassandra
- 技術撰稿人:
- dvohra
- 專案名稱:
- Apache Cassandra 4.0 說明文件更新,並解決說明文件中的 TODO 事項
- 專案長度:
- 長時間放送 (5 個月)
Project description
專案包含兩個子專案,如下所示:
1. Apache Cassandra 4.0 說明文件更新
請查看並更新現有的 Apache Cassandra 說明文件,確保其
符合即將推出的 Apache Cassandra 4.0 版本。我們建議
採用的方法是,先向 Cassandra 開發人員的 cassandra-dev
電子郵件列表發出呼叫,請他們標出需要更新的文件
部分。其次,我們會彙整一份條理分明的
審查現有文件,找出潛在的缺失部分。例如:
技術文件撰寫人員可以在結構化審查中,比較
Cassandra 設定檔說明文件
(http://cassandra.apache.org/doc/latest/configuration/cassandra_config_file.html)
以及來源中實際包含的設定選項
(https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/config/Config.java
2. 解決 Apache Cassandra 說明文件中的 TODO
Apache Cassandra 說明文件包含多個以「TODO」
醒目顯示的區段 (或尚未完成的工作)。包括:
- 操作 Cassandra / 備份
- 操作 Cassandra / 大量載入
- CQL / 資料定義 (有限審查點)
- 建立資料模型
- Dynamo / Gossip、失敗偵測和符記環
- 架構/保證
- 操作 Cassandra/提示
- 架構/總覽 (建議做為獨立專案)
- 執行 Cassandra/Read Repair
- 許多社群成員都製作了相關主題的內容 (包括公開網誌文章、Stack Overflow 文章等)。如要完成這些部分,最有效率的方法是向電子郵寄清單索取優質的參考資料和內容,並將其整合為 Apache Cassandra 說明文件集的簡明文件。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\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."]]