为 Ansible 文档贡献内容

Ansible 拥有大量的文档，但编写人员团队规模较小。社区支持帮助我们跟上新功能、修复和更改的步伐。

改进文档是为 Ansible 项目做出首次贡献的简单方法。您无需成为程序员，因为我们的大多数文档都是用 YAML（模块文档）或 reStructuredText（rST）编写的。一些集合级别的文档是用 Markdown 的子集编写的。如果您正在使用 Ansible，那么您已经在 playbook 中使用了 YAML。rST 和 Markdown 基本上只是文本。如果您使用 Edit on GitHub 选项，您甚至不需要 Git 经验。

如果您发现错别字、失效的示例、缺少的主题或此文档网站上的任何其他错误或遗漏，请告知我们。以下是一些支持 Ansible 文档的方法

直接在 GitHub 上编辑文档

对于错别字和其他快速修复，您可以直接在站点上编辑大多数文档。查看此页面右上角。该 Edit on GitHub 链接在文档中的所有指南页面上都可用。如果您有 GitHub 帐户，则可以通过这种方式提交快速简单的拉取请求。

注意

单个集合插件的源文件存在于它们各自的存储库中。请按照 Galaxy 上集合的链接查找存储库的位置以及有关如何为该集合做出贡献的任何指南。

要使用 docs.ansible.com 上的 Edit on GitHub 提交文档 PR

  1. 点击 Edit on GitHub。

  2. 如果您还没有在您的 GitHub 帐户上为 ansible 存储库创建分支，系统会提示您创建一个。

  3. 修复错别字，更新示例，或进行您想到的任何其他更改。

  4. 在 GitHub 页面底部的标题 Propose file change 下的第一个矩形中输入提交消息。越具体越好。例如，“修复 my_module 描述中的错别字”。如果需要，您可以在第二个矩形中添加更多详细信息。保留 +label: docsite_pr。

  5. 通过点击绿色的“Propose file change”按钮提交建议的更改。GitHub 将为您处理分支和提交，并打开一个标题为“Comparing Changes”的页面。

  6. 点击 Create pull request 打开 PR 模板。

  7. 填写 PR 模板，包括与您的更改相关的尽可能多的详细信息。如果您愿意，可以更改 PR 的标题（默认情况下它与您的提交消息相同）。在 Issue Type 部分，删除除 Docs Pull Request 行之外的所有行。

  8. 通过点击 Create pull request 按钮提交您的更改。

  9. 请耐心等待，我们的自动化脚本 Ansibot 会添加标签，通知文档维护人员，并启动 CI 测试运行。

  10. 留意您的 PR - 文档团队可能会要求您进行更改。

审查或解决未解决的问题

审查或解决以下内容的开放文档问题

审查开放的 PR

审查以下内容的开放文档拉取请求

要添加有帮助的审查，请

  • 如果适用，请测试更改。

  • 思考是否可以改进（包括措辞、结构、修复错别字等）。

  • 建议改进。

  • 使用 looks good to me 评论批准更改。

打开一个新的问题和/或 PR

如果您注意到的问题过于复杂，无法使用 Edit on GitHub 选项修复，并且没有开放的问题或 PR 已经记录了该问题，请在正确的底层存储库上打开一个问题和/或 PR - 大多数非插件或模块文档的页面都使用 ansible/ansible-documentation。如果文档页面没有 Edit on GitHub 选项，请检查该页面是否属于集合中的模块。如果是，请按照 Galaxy 上集合的链接，然后选择右上角的 repo 按钮以查找该集合和模块的源存储库。集合自述文件应包含有关如何为该集合做出贡献或报告问题的信息。

一个优秀的文档 GitHub 问题或 PR 包括

  • 一个具体的标题

  • 对问题的详细描述（即使对于 PR 也是如此 - 除非我们知道它旨在解决什么问题，否则很难评估建议的更改）

  • 其他信息的链接（相关问题/PR、外部文档、docs.ansible.com 上的页面等）

验证您的文档 PR

如果您对 Ansible 文档进行多次更改，或向其中添加一行以上内容，请在打开拉取请求之前

  1. 检查您的文本是否符合我们的 Ansible 文档样式指南。

  2. 测试您的更改是否存在 rST 错误。

  3. 构建页面，最好是整个文档站点，在本地构建。

注意

以下部分适用于来自 ansible/ansible-documentation 存储库的文档，不适用于来自单个集合的文档。有关如何为该集合做出贡献的详细信息，请参阅集合自述文件。集合开发者还可以整理其集合级别的文档。有关详细信息，请参阅 验证您的集合文档。

设置本地构建文档的环境

要在本地构建文档，请确保您拥有一个可用的 开发环境。

要在本地机器上处理文档，您应该使用满足 ansible-core 最低要求的 Python 版本。有关 Python 最低版本的信息，请参阅 支持矩阵。

  1. 设置一个虚拟环境，用于安装依赖项。

    python3 -m venv ./venv
source ./venv/bin/activate

  2. 克隆 Ansible 核心所需的文档构建部分。

    python3 docs/bin/clone-core.py

  3. 安装未固定或测试的文档依赖项。

    pip install -r tests/requirements.in -c tests/requirements.txt # Installs tested dependency versions.
pip install -r tests/requirements.in # Installs the unpinned dependency versions.
pip install -r tests/requirements-relaxed.in # Installs the unpinned dependency versions including untested antsibull-docs.

注意

在检出 ansible/ansible-documentation 后，请确保 docs/docsite/rst 目录具有足够严格的权限。它只能由所有者帐户写入。如果您的默认 umask 不是 022，您可以使用 chmod go-w docs/docsite/rst 在新分支中正确设置权限。或者，您可以将 umask 设置为 022，以使系统上所有新创建的文件（包括 git clone 创建的文件）具有正确的权限。

在本地测试文档

要测试单个文件是否存在 rST 错误

rstcheck changed_file.rst

在本地构建文档

构建文档是检查错误和审查更改的最佳方法。一旦 `rstcheck` 运行没有错误，导航到 `ansible-documentation/docs/docsite`，然后构建您要审查的页面。

注意

如果在 macOS 上使用 Python 3.8 或更高版本构建，则必须使用 Sphinx >= 2.2.2。有关详细信息，请参阅 #6803。

定期克隆 Ansible Core

位于 `ansible/ansible-documentation` 存储库中的文档构建在 `ansible/ansible` 存储库“之上”。当您设置本地构建环境时，请克隆 Ansible Core 的相关部分。

为了确保您使用 Ansible Core 的最新源代码，您应该在构建文档之前定期运行以下脚本

python3 docs/bin/clone-core.py

构建单个 rST 页面

使用 make 实用程序构建单个 rST 文件

make htmlsingle rst=path/to/your_file.rst

例如

make htmlsingle rst=community/documentation_contributions.rst

此过程编译所有链接，但提供最少的日志输出。如果您正在编写新页面或需要更详细的日志输出，请参阅有关 使用 sphinx-build 构建 rST 文件 的说明。

注意

`make htmlsingle` 会在您在 `rst=` 中提供的路径的开头添加 `rst/`，因此您无法使用自动完成功能键入文件名。以下是在此操作错误时将看到的错误消息。

  • 如果您从 `docs/docsite/rst/` 目录运行 `make htmlsingle`：`make: *** No rule to make target `htmlsingle'.  Stop.`。

  • 如果您从 `docs/docsite/` 目录使用 rST 文档的完整路径运行 `make htmlsingle`：`sphinx-build: error: cannot find files ['rst/rst/community/documentation_contributions.rst']`。

构建所有 rST 页面

要构建几乎没有模块文档的所有 rST 文件

make coredocs

这实际上是在构建 ansible-core 文档，而不是 Ansible 社区软件包文档，后者包含许多集合的文档。

构建模块文档和 rST 页面

要构建 Ansible 社区软件包的所有模块文档以及所有 rST 文件

make webdocs

使用 `sphinx-build` 构建 rST 文件

高级用户可以直接使用 sphinx 实用程序构建一个或多个 rST 文件。如果您只构建单个页面，`sphinx-build` 会返回误导性的 `undefined label` 警告，因为它不会创建内部链接。但是，`sphinx-build` 会返回更广泛的语法反馈，包括有关缩进错误和 `x-string without end-string` 警告。这很有用，尤其是在您从头开始创建新页面时。要使用 `sphinx-build` 构建页面

sphinx-build [options] sourcedir outdir [filenames...]

您可以指定文件名，或使用 `-a` 表示所有文件，或者两者都不指定以仅编译新/更改的文件。

例如

sphinx-build -b html -c rst/ rst/dev_guide/ _build/html/dev_guide/ rst/dev_guide/developing_modules_documenting.rst

运行最终测试

当您提交文档拉取请求时，会运行自动测试。这些相同的测试可以在本地运行。为此，请导航到存储库的顶级目录并运行

make clean -C docs/docsite
python tests/checkers.py docs-build
python tests/checkers.py rstcheck

建议在存储库的干净副本上运行测试，这是 `make clean` 命令的目的。

加入文档工作组

文档工作组 (DaWGs) 每周二在 docs:ansible.im 聊天室 (Matrix) 中举行会议。有关更多信息，包括我们议程的链接，请访问我们的 论坛小组。

另请参阅

有关测试模块文档的更多信息

有关记录模块的更多信息