このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- Apache Cassandra
- テクニカル ライター:
- dvohra
- プロジェクト名:
- Apache Cassandra 4.0 のドキュメントの更新と、ドキュメントの TODO の解決
- プロジェクト期間:
- 長期実行（5 か月）
プロジェクトの説明
プロジェクトは次の 2 つのサブプロジェクトで構成されています。
1. Apache Cassandra 4.0 のドキュメントの更新
既存の Apache Cassandra ドキュメントを確認して更新し、今後の Apache Cassandra 4.0 リリースに合わせて調整します。
これに対して Google が提案する
アプローチは、まず 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/読み取り修復のオペレーション
- コミュニティの多くのメンバーが、これらのトピックに関する資料（公開ブログ投稿、Stack Overflow の投稿など）を作成しています。これらのセクションを完成させる最も生産的な方法は、メーリング リストから優れた参考資料をリクエストし、Apache Cassandra ドキュメント セットの簡潔なドキュメントにまとめることです。