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

問題を報告する ソースを表示 夜間 · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel のドキュメントにご協力いただき、ありがとうございます。Google Chat で コミュニティに役立つドキュメントの作成にご協力ください

ドキュメントの種類

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

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

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

Bazel のドキュメントは Google から提供され、ソースファイルは Google Cloud でミラーリングされます。 Bazel の GitHub リポジトリ。GitHub でソースファイルに変更を加えることができます。 承認された場合は変更をマージでき、Bazel の管理者が 更新を公開するためのウェブサイト ソースを指定します。

小さな変更

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

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

大規模な変更

既存のドキュメントに大幅な変更を加える場合や、 pull リクエストを作成するか、Google Cloud の ドキュメントを参照し、Bazel オーナーに連絡してコラボレーションを依頼してください。