为 Bazel 文档做贡献

报告问题 查看源代码 每夜版 · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

感谢您为 Bazel 的文档做出贡献！您可以通过多种方式帮助我们为社区创建更好的文档。

文档类型

此网站包含多种类型的内容。

  • 叙述性文档，由技术撰稿人和工程师撰写。本网站的大部分内容都是叙述性文档，涵盖概念指南和基于任务的指南。
  • 参考文档，即根据代码注释生成的文档。 您无法直接更改参考文档页面，而是需要更改其来源。

文档基础架构

Bazel 文档由 Google 提供，源文件镜像在 Bazel 的 GitHub 代码库中。您可以更改 GitHub 中的源文件。如果获得批准，您可以合并更改，Bazel 维护人员将更新网站来源以发布您的更新。

小幅更改

您可以通过多种方式进行小幅更改，例如修正错误或拼写错误。

  • 拉取请求。您可以在 GitHub 中使用基于网络的编辑器或在分支上创建拉取请求。
  • 错误。您可以提交包含详细信息和建议更改的 bug，然后 Bazel 文档所有者会进行更新。

大幅更改

如果您想对现有文档进行重大更改或提议创建新文档，可以创建 pull 请求，也可以先创建 Google 文档，然后与 Bazel 所有者联系以进行协作。