感谢您为 Bazel 文档做出贡献!您可以通过以下几种方式为我们的社区创建更实用的文档。
文档类型
该网站包含几种类型的内容。
- 叙事文档,由技术撰稿人和工程师撰写。本网站的大部分内容都是叙述性文档,涵盖概念和任务指南。
- 参考文档,即根据代码注释生成的文档。您无法直接更改参考文档页面,而需要更改其来源。
文档基础架构
Bazel 文档由 Google 提供,源文件会镜像到 Bazel 的 GitHub 代码库中。您可以在 GitHub 中更改源文件。如果获得批准,您可以合并更改,然后 Bazel 维护者会更新网站源代码以发布您的更新。
细微更改
您可以通过多种方式进行细微更改,例如修正错误或拼写错误。
- 拉取请求。您可以在 GitHub 中使用基于 Web 的编辑器或在分支上创建拉取请求。
- 错误。您可以提交 bug,并附上详细信息和建议的更改,Bazel 文档所有者将进行更新。
重大变更
如果您想对现有文档进行重大更改或提议新文档,可以创建一个拉取请求,也可以先创建一个 Google 文档,然后与 Bazel 所有者联系以进行协作。