为 Bazel 文档做贡献

感谢您为 Bazel 的文档贡献力量!您可以通过多种方式 为我们的社区创建更好的文档

文档类型

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

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

文档基础架构

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

细微更改

您可以通过几种方式处理细微更改,例如修正错误或拼写错误。

  • 拉取请求。您可以使用基于 Web 的编辑器或在 GitHub 中创建拉取请求。
  • 错误。您可以提交 bug 并提供详细信息和建议更改,Bazel 文档所有者将进行更新。

大幅更改

如果您想对现有文档进行重大更改或提出新文档建议,可以创建拉取请求,也可以从 Google 文档着手,然后与 Bazel 所有者联系以进行协作。