ansible-collections/community.mysql

Use attributes in module docs instead of notes

Andersson007 opened this issue · 0 comments

SUMMARY

At present, we use the notes: field in the DOCUMENTATION section to show our users that modules support check_mode and other stuff.

There's another field called attributes: that can be used and looks imo much better on doc.ansible.com.

We would appreciate if someone adds this field to modules' DOCUMENTATION sections (see files under plugins/modules) and moves check mode support to it from notes:. Maybe there's another stuff that can be moved as well.

The link to the Quick-start dev guide.

See:
ansible-collections/ansible-inclusion#59 (reply in thread)
https://docs.ansible.com/ansible/devel/collections/community/hashi_vault/vault_kv2_delete_module.html#attributes