このページには、Google シーズンの Google ドキュメントで承認されたテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- 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 ドキュメント セットの簡潔なドキュメントにまとめることです。