为 Bazel 文档做贡献

报告问题 查看来源 每晚 · 7.2。 · 7.1敬上 · 7.0 · 6.5 · 6.4

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

文档类型

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

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

文档基础架构

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

小幅改动

您可以通过多种方法处理一些细微的更改,例如修正错误或拼写错误。 方法。

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

大幅更改

如果您想对现有文档进行重大更改或提议 您可以创建一个拉取请求 文档,并与 Bazel 所有者联系以进行协作。