You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.
Note that positional is only available for lookup, filter, and test plugins, not for any other plugin type, or for modules.
The documentation linked above is mostly written for modules, not for other plugin types. Many parts are also true for other plugin types, but not everything that's needed or allowed for plugins is mentioned there.
At some point we need to refactor these documentations to make clear what's correct for which module/plugin type.
The Documentation fields part of https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html does not mention the
positional
key, that - at least to the reviewer that reviewed my contribution - is needed at least for filters.The docs checkers also insisted on specifying the
name
, notmodule
. Maybe the whole schema might benefit from reviewing.Thanks
The text was updated successfully, but these errors were encountered: