Bazel のドキュメントにご協力いただき、ありがとうございます。コミュニティに役立つドキュメントの作成を支援する方法がいくつかあります。
ドキュメントの種類
このサイトには、数種類のコンテンツが含まれています。
- テクニカル ライターとエンジニアによって書かれたナラティブ ドキュメント。このサイトのほとんどは、コンセプトとタスクベースのガイドを網羅したナラティブのドキュメントです。
- リファレンス ドキュメント。コードコメントからドキュメントが生成されます。リファレンス ドキュメントのページを直接変更することはできませんが、ソースを変更する必要があります。
ドキュメント インフラストラクチャ
Bazel のドキュメントは Google から提供され、ソースファイルは Bazel の GitHub リポジトリでミラーリングされます。GitHub でソースファイルを変更できます。承認された場合は、変更を統合できます。Bazel の管理者がウェブサイト ソースを更新し、更新を公開します。
小さな変更
エラーや入力ミスの修正などの小さな変更には、いくつかの方法があります。
- pull リクエスト。pull リクエストは、GitHub でウェブベースのエディタを使用するか、ブランチで作成できます。
- バグ:詳細と推奨される変更を含むバグを報告すると、Bazel のドキュメント所有者が更新を行います。
大規模な変更
既存のドキュメントに大幅な変更を加える場合や、新しいドキュメントを提案する場合は、pull リクエストを作成するか、Google ドキュメントから開始して、Bazel オーナーに連絡して共同作業します。