Документирование новых сетевых платформ

Изменение таблицы параметров платформы

Таблица Настройки по платформам — это удобный свод параметров подключений, предоставляемых каждой сетевой платформой, имеющей модули в 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.