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