Bazel のドキュメントにご協力いただき、ありがとうございます。コミュニティ向けにより良いドキュメントを作成するための いくつかの方法があります
ドキュメントの種類
このサイトには、いくつかの種類のコンテンツが含まれています。
- ナラティブ ドキュメント: テクニカル ライターとエンジニアが作成します。このサイトの大部分は、コンセプト ガイドとタスクベースのガイドを取り上げたナラティブ ドキュメントです。
- リファレンス ドキュメント: コードコメントから生成されるドキュメントです。リファレンス ドキュメントのページを直接変更することはできませんが、ソースを変更する必要があります。
ドキュメント インフラストラクチャ
Bazel のドキュメントは Google から提供されており、ソースファイルは Bazel の GitHub リポジトリにミラーリングされています。GitHub でソースファイルを変更できます。承認された場合は、変更をマージできます。その場合、Bazel の管理者がウェブサイトのソースを更新して更新を公開します。
小さな変化
エラーや入力ミスの修正などの小さな変更には、いくつかの方法があります。
- pull リクエスト。pull リクエストは、ウェブベースのエディタを使用して GitHub で、またはブランチで作成できます。
- バグ:詳細と推奨される変更を記載したバグを報告できます。Bazel のドキュメントのオーナーが更新を行います。
大きな変更
既存のドキュメントに大幅な変更を加える場合、または新しいドキュメントを提案する場合は、pull リクエストを作成するか、Google ドキュメントを使用して Bazel のオーナーに相談してください。