记录新的网络平台

当您为新平台创建网络模块，或修改现有网络平台（例如 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 文档贡献代码 。