Bazel のドキュメントにご協力いただき、ありがとうございます。コミュニティのためにより良いドキュメントを作成するのに役立つ方法はいくつかあります。
ドキュメントの種類
このサイトには、数種類のコンテンツが含まれています。
- ストーリー ドキュメント。テクニカル ライターとエンジニアが作成します。このサイトの大半は、コンセプト ガイドとタスクベース ガイドの内容を説明するドキュメントです。
- リファレンス ドキュメント: コードコメントから生成されます。参照ドキュメントのページを直接変更することはできませんが、ソースを変更する必要があります。
ドキュメント インフラストラクチャ
Bazel のドキュメントは Google から提供され、ソースファイルは Bazel の GitHub リポジトリにミラーリングされます。GitHub でソースファイルを変更できます。承認された場合は、変更をマージできます。Bazel のメンテナンス担当者がウェブサイトのソースを更新して更新を公開します。
小さな変化
エラーや入力ミスの修正など、小さな変更にはいくつかの方法で対処できます。
- pull リクエスト。pull リクエストは、ウェブベースのエディタまたはブランチで GitHub に作成できます。
- バグ。詳細と推奨される変更を記載したバグを報告すると、Bazel のドキュメント オーナーが更新を行います。
大幅な変更
既存のドキュメントを大幅に変更するか、新しいドキュメントを提案する場合は、pull リクエストを作成するか、Google ドキュメントから開始し、Bazel オーナーに連絡して共同編集します。