Bazel のドキュメントに貢献する

問題を報告する ソースを表示 夜間 7.4 をタップします。 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel のドキュメントの作成にご協力いただきありがとうございます。コミュニティ向けのより良いドキュメントを作成するための方法はいくつかあります。

ドキュメントの種類

このサイトには、いくつかの種類のコンテンツが含まれています。

  • ナラティブ ドキュメント: テクニカル ライターとエンジニアが作成します。このサイトの大部分は コンセプト ガイドとタスクベースのガイドが用意されています。
  • リファレンス ドキュメント。コードコメントからドキュメントが生成されます。 リファレンス ドキュメントのページを直接変更することはできませんが、代わりに ソースを変更できます。

ドキュメント インフラストラクチャ

Bazel のドキュメントは Google から提供され、ソースファイルは Google Cloud でミラーリングされます。 Bazel の GitHub リポジトリ。GitHub でソースファイルを変更できます。承認されたら、変更を統合できます。Bazel のメンテナンス担当者がウェブサイトのソースを更新して、更新を公開します。

小さな変更

エラーや入力ミスの修正などの小さな変更には、いくつかの方法で対処できます。 できます。

  • pull リクエスト。GitHub で pull リクエストを作成するには、 ウェブベースのエディタやブランチで実行できます。
  • バグ。詳細と推奨される変更を記載したバグを報告すると、Bazel ドキュメントのオーナーが更新を行います。

大規模な変更

既存のドキュメントに大幅な変更を加えたり、新しいドキュメントを提案したりするには、プルリクエストを作成するか、Google ドキュメントから始めて、Bazel オーナーに連絡して共同編集します。