本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構:
- Apache Cassandra
- 技術文件撰寫者:
- dvohra
- 專案名稱:
- Apache Cassandra 4.0 說明文件中的更新並解析為說明文件
- 專案長度:
- 長時間執行 (5 個月)
Project description
專案包含兩個子專案,如下所示:
1. Apache Cassandra 4.0 說明文件更新
檢閱並更新現有的 Apache Cassandra 說明文件,確保該說明文件
與即將推出的 Apache Cassandra 4.0 版本一致。我們提議的
方法是先呼叫 cassandra-dev
郵寄清單,讓 Cassandra 協作者醒目顯示文件中有哪些部分需要更新
。其次,我們將對現有說明文件進行結構化的審查,
找出潛在的資料落差。針對
範例:在結構化審查中,技術寫入者可以比較
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 / 大量載入
- 有效待開發銷售對象 / 資料定義 (有限評論重點)
- 建立資料模型
- Dynamo / 八卦、失敗偵測和權杖環
- 建築/證明
- 作業 Cassandra/提示
- 架構/總覽 (建議做為個別專案使用)
- 作業 Cassandra/讀取修復
- 許多社群成員製作了有關這些主題的內容 (包括公開網誌文章、Stack Overflow 文章等)。完成這些部分最有效率的方法,可能是從郵寄清單要求優良的參考資料和資料,然後整合成 Apache Cassandra 說明文件集的精簡文件。