为 Bazel 文档做贡献

报告问题 查看源代码

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

文档类型

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

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

文档基础架构

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

小幅改动

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

  • 拉取请求。您可以使用基于网络的编辑器在 GitHub 中创建拉取请求,也可以在某个分支上创建。
  • 错误。您可以提交 bug 并提供详细信息和建议更改,Bazel 文档所有者将执行更新。

大幅更改

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