Add support for filter and test plugins

ansible-collections / ansible.netcommon

Ansible Network Collection for Common Code

GNU General Public License v3.0

145 stars 104 forks source link

Add support for filter and test plugins #474

Open samccann opened 2 years ago

samccann commented 2 years ago

SUMMARY

ansible-core 2.14 adds 'side car docs' which gives collection owners the ability to add documentation for previously undocumentable filter and test plugins.

This requires creating yaml files in the same directory as the filter or test plugin code, one yaml file per plugin.

See https://github.com/ansible/ansible/blob/devel/lib/ansible/plugins/filter/b64decode.yml for an example.

ISSUE TYPE

Documentation Report

COMPONENT NAME

ANSIBLE VERSION

2.14

samccann commented 2 years ago

The following filter plugins need documentation: ansible.netcommon.comp_type5 –

ansible.netcommon.hash_salt –

ansible.netcommon.parse_cli –

ansible.netcommon.parse_cli_textfsm –

ansible.netcommon.parse_xml –

ansible.netcommon.type5_pw –

ansible.netcommon.vlan_expander –

ansible.netcommon.vlan_parser –

samccann commented 2 years ago

Ideal timeline would be to provide these by the time Ansible 7 releases at the end of November but we realize this information wasn't conveyed to collection owners on a more timely basis.