为 Ansible 文档贡献

Ansible 有很多文档，但只有一个小型的编写团队。社区支持帮助我们跟上新功能、修复和更改的步伐。

改进文档是为 Ansible 项目做出第一份贡献的简便方法。您无需成为程序员，因为我们的大部分文档都是用 YAML（模块文档）或 reStructuredText（rST）编写的。一些集合级文档是用 Markdown 的子集编写的。如果您正在使用 Ansible，您已经在您的剧本中使用 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（我们的自动化脚本）添加标签、ping 文档维护人员并启动 CI 测试运行。

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

查看或解决开放问题

查看或解决 Ansible 项目的开放文档问题

查看开放的 PR

查看 Ansible 文档的开放文档拉取请求

要添加有帮助的评论，请

  • 测试更改，如果适用。

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

  • 建议改进。

  • 使用 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 存储库中获取的文档，不适用于来自单个集合的文档。有关如何为该集合做出贡献的详细信息，请参阅集合自述文件。集合开发者也可以对他们集合级的文档进行 lint。有关详细信息，请参阅 验证您的集合文档。

在本地设置您的环境来构建文档

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

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

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

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

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

    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/ 目录运行 make htmlsingle，并使用 rST 文档的完整路径：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 聊天中举行会议（使用 Matrix 或使用 irc.libera.chat 上的 IRC）。有关更多信息，包括我们的议程链接和日历邀请，请访问我们的 论坛组。

另请参见

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

有关记录模块的更多信息