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