Ansible 文档风格指南

欢迎来到 Ansible 风格指南！为了在 docs.ansible.com 上创建清晰、简洁、一致、有用的材料，请遵循以下指南

语言指南 

我们希望 Ansible 文档能够做到

清晰
直接
对话式
易于翻译

我们希望阅读文档的感觉就像是一位经验丰富、友好的同事在解释 Ansible 的工作原理。

风格速查表 

这份速查表说明了一些有助于实现“Ansible 语气”的规则。

规则	好的例子	不好的例子
使用主动语态	您可以通过以下方式运行任务	任务可以通过以下方式运行
使用现在时	此命令创建一个	此命令将创建一个
称呼读者	当您扩展清单时	当管理节点的数量增长时
使用标准英语	返回此页面	跳回此页面
使用美式英语	输出的颜色	输出的颜色

标题和标题大小写 

标题和标题应该使用句首字母大写。例如，本节的标题是 Title and heading case，而不是 Title and Heading Case 或 TITLE AND HEADING CASE。

避免使用拉丁语短语 

像 e.g. 或 etc. 这样的拉丁词语和短语很容易被英语使用者理解。它们可能难以被其他人理解，并且对于自动翻译来说也很棘手。

使用以下英语术语代替拉丁语术语或缩写

拉丁语	英语
i.e	换句话说
e.g.	例如
etc	等等
via	通过/通过
vs./versus	而不是/反对

reStructuredText 指南 

Ansible 文档是用 reStructuredText 编写的，并由 Sphinx 处理。我们遵循所有 rST 页面上的这些技术或机械指南

标题符号 

reStructuredText 中的节标题可以使用各种符号。Sphinx 会在创建标题层次结构时“即时学习”。为了使我们的文档易于阅读和编辑，我们遵循一组标准的标题符号。我们使用

### 带上横线，用于部分

###############
Developer guide
###############

*** 带上横线，用于章节

*******************
Ansible style guide
*******************

=== 用于节

Mechanical guidelines
=====================

--- 用于小节

Internal navigation
-------------------

^^^ 用于子小节

Adding anchors
^^^^^^^^^^^^^^

""" 用于段落

Paragraph that needs a title
""""""""""""""""""""""""""""

语法高亮 - Pygments 

Ansible 文档支持各种 Pygments 词法分析器用于语法高亮使我们的代码示例看起来不错。每个代码块必须正确缩进并用空行包围。

Ansible 文档允许使用以下值

none (无高亮)
ansible-output (Ansible 输出的自定义词法分析器)
bash
console
csharp
ini
json
powershell
python
rst
sh
shell
shell-session
text
yaml
yaml+jinja

例如，您可以使用以下语法突出显示 Python 代码

.. code-block:: python

   def my_beautiful_python_code():
      pass

内部导航 

锚点（也称为标签）和链接协同工作，帮助用户找到相关内容。本地目录树也帮助用户快速找到所需的信息。所有内部链接都应该使用 :ref: 语法。每个页面至少应该有一个锚点来支持内部 :ref: 链接。长页面或包含多个标题级别的页面也可以包含本地 TOC。

注意

避免使用原始 URL。RST 和 sphinx 允许 https://my.example.com，但这对使用屏幕阅读器的人来说没有帮助。 :ref: 链接会自动从锚点中提取标题，但对于外部链接，始终使用 `link title <link-url>`_ 格式。

添加指向模块和插件的链接 

使用 :ansplugin: RST 角色通过其完全限定的集合名称 (FQCN) 来链接到模块和插件

The ansible.builtin.copy module can be linked with
:ansplugin:`ansible.builtin.copy#module`

If you want to specify an explicit type, use:
:ansplugin:`the copy module <ansible.builtin.copy#module>`

这将显示为“ansible.builtin.copy 模块可以通过 ansible.builtin.copy 链接”和“如果您想指定显式类型，请使用：copy 模块”。

除了 #module，您也可以指定 #<plugin_type> 来引用类型为 <plugin_type> 的插件。

:ansplugin:`arista.eos.eos_config <arista.eos.eos_config#module>`
:ansplugin:`kubernetes.core.kubectl connection plugin <kubernetes.core.kubectl#connection>`
:ansplugin:`ansible.builtin.file lookup plugin <ansible.builtin.file#lookup>`

注意

ansible.builtin 是包含在 ansible-core 中的模块的 FQCN。

向模块和插件选项以及返回值添加链接 

使用 :ansopt: 和 :ansretval: 角色来引用模块和插件的选项和返回值。

:ansopt:`ansible.builtin.file#module:path` references the ``path`` parameter of the
``ansible.builtin.file`` module; :ansopt:`ansible.builtin.file#module:path=/root/.ssh/known_hosts`
shows the assignment ``path=/root/.ssh/known_hosts`` as a clickable link.

:ansretval:`ansible.builtin.stat#module:stat.exists` references the ``stat.exists`` return value
of the ``ansible.builtin.stat`` module. You can also use ``=`` as for option values:
:ansretval:`ansible.builtin.stat#module:stat.exists=true` shows ``stat.exists=true``.

:ansopt:`foo` and :ansopt:`foo=bar` use the same markup for an option and an option
assignment without a link; the same is true for return values: :ansretval:`foo` and
:ansretval:`foo=bar`.

这将显示为“path 引用 ansible.builtin.file 模块的 path 参数；path=/root/.ssh/known_hosts 显示赋值 path=/root/.ssh/known_hosts 作为可点击链接。” 以及“stat.exists 引用 ansible.builtin.stat 模块的 stat.exists 返回值。您也可以使用 = 作为选项值：stat.exists=true 显示 stat.exists=true。” 以及“foo 和 foo=bar 对选项和没有链接的选项分配使用相同的标记；返回值也是如此：foo 和 foo=bar。”。

对于选项和返回值，. 用于引用子选项和包含的返回值。数组存根 ([...]) 可用于指示某项是列表，例如 :retval: 参数 ansible.builtin.service_facts#module:ansible_facts.services['systemd'].state 引用 ansible.builtin.service_facts 模块的 ansible_facts.services.state 返回值 (ansible_facts.services['systemd'].state)。

添加本地 TOC 

您正在阅读的页面包含一个本地 TOC。如果您包含一个本地 TOC

将其放在主标题和（可选）介绍性文本下方，而不是上方
使用 :local: 指令，这样页面的主标题就不会被包含在内
不要包含标题

语法是

.. contents::
   :local:

Markdown 指南 

一些 Ansible 生态系统文档是用 markdown 编写的，并由 mkdocs 处理。我们在所有 .md 页面上遵循以下技术或机械指南

标题表示法 

markdown 中的节标题可以使用多种表示法。为了使我们的文档易于阅读和编辑，我们遵循一组标准的标题表示法。我们使用

# 用于页面标题

# Installation

## 用于节标题

## Installing on Linux

每个子节都会添加一个额外的 #。我们建议不要超过 ####，因为这表明一个深度嵌套的文档，最好以多个页面呈现。

Markdown 中的链接 

使用 Mkdocs，您可以使用本地文件的文件名而不是外部 URL 来格式化内部链接 <https://mkdocs.pythonlang.cn/user-guide/writing-your-docs/#writing-with-markdown>`_。

[configuration](/configuration)

您也可以直接链接到文件中的标题。使用标题的小写形式。

[dependency](/configuration/#dependency)

外部链接使用类似的格式，带有外部 URL。

[Ansible Documentation](https://docs.ansible.org.cn)

代码块 

Markdown 支持以下格式的代码块。

```text
docs/
    index.md
    user-guide/getting-started.md
    user-guide/configuration-options.md
    license.md
```

无障碍指南 

Ansible 文档的目标是更易于访问。使用以下指南帮助我们实现这一目标。

图像和替代文本 

确保所有图标、图像、图表和非文本元素都有有意义的替代文本描述。不要包含 CLI 输出的屏幕截图。改为使用代码块。

要在 rst 中添加替代文本

.. image:: path/networkdiag.png
   :width: 400
   :alt: SpiffyCorp network diagram

要在 md 中添加替代文本

![SpiffyCorp network diagram](path/networkdiag.png)

链接和超文本 

URL 和交叉引用链接包含描述性文本，传达有关链接目标内容的信息。有关如何在 RST 中格式化链接的信息，请参见内部导航，有关如何在 Markdown 中格式化链接的信息，请参见 Markdown 中的链接。

表格 

表格具有从左到右和从上到下的简单、逻辑的阅读顺序。表格包含标题行，并避免空或空白表格单元格。使用描述性标题标记表格。

对于 RST

.. table:: File descriptions

  +----------+----------------------------+
  |File      |Purpose                     |
  +==========+============================+
  |foo.txt   |foo configuration settings  |
  +----------+----------------------------+
  |bar.txt   |bar configuration settings  |
  +----------+----------------------------+

对于 Markdown

#### File descriptions

  |File       |Purpose                     |
  |---------- | -------------------------- |
  |foo.txt    | foo configuration settings |
  |bar.txt    | bar configuration settings |

颜色和其他视觉信息 

避免仅依赖感官特征的说明。例如，不要使用 Click the square, blue button to continue.

通过方法而不是仅仅通过颜色来传达信息。

确保图像和图表中前景和背景文本或图形元素之间有足够的对比度。

用于浏览界面的说明在没有方向指示器（如左、右、上、下）的情况下是有意义的。

无障碍资源 

使用以下资源来帮助测试您的文档更改

axe DevTools 浏览器扩展 - 突出显示网站页面上的无障碍问题。
WAVE 浏览器扩展来自 WebAIM - 另一个无障碍测试器。
Orca 屏幕阅读器 - 视力障碍人士常用的工具。
颜色过滤器 - 用于色盲测试。