记录新的网络平台

当你为新的平台创建网络模块，或修改现有网络平台（例如 network_cli 和 httpapi）提供的连接时，你还需要更新按平台设置表，并为你的平台添加或修改平台选项文件。

你应该已经按照 模块格式和文档 中的描述记录了每个模块。

修改平台选项表

按平台设置 表是 Ansible 中具有模块的每个网络平台提供的连接选项的便捷摘要。按字母顺序向此表中添加你的平台的行。例如：

+-------------------+-------------------------+-------------+---------+---------+----------+
| My OS             | ``myos``                | ✓           | ✓       |         | ✓        |

确保表格格式正确。即：

• 每行按字母顺序插入。

• 单元格分隔符 | 与 + 标记对齐。

• 复选标记仅出现在网络模块提供的连接类型中。

添加平台特定选项部分

平台特定部分是单独的 .rst 文件，为你的网络平台模块的用户提供更详细的信息。将你的新文件命名为 platform_<name>.rst (例如, platform_myos.rst)。平台名称应与模块前缀匹配。有关你应在平台特定选项部分中提供的详细信息示例，请参见 platform_eos.rst 和 EOS 平台选项。

你的平台特定部分应包括以下内容：

• 可用连接表 - 深入了解每种连接类型，包括凭据、间接访问、连接设置和启用模式的详细信息。

• 如何使用每种连接类型 - 提供每种连接类型的工作示例。

如果你的网络平台支持 SSH 连接，则还应在你的 .rst 文件底部包含以下内容：

.. include:: shared_snippets/SSH_warning.txt

将新文件添加到目录

最后一步，按字母顺序在 platform_index.rst 文件中添加你的新文件。然后，你应该构建文档以验证你的添加。有关更多详细信息，请参见为 Ansible 文档做贡献。