RFE: Documentation. Document Event Source plugins in a manner similar to the ansible collection index
bontreger opened this issue · 2 comments
CROSS POSTED from ansible/ansible-rulebook#560
Feature type
New Feature
Feature Summary
Working with the available event sources is challenging as the available configuration parameters are not published and require scraping the python code to find the possible configuration parameters.
By including a collection index for these modules, similar to the ansible plugins docs, users can create their own rulebooks easier https://docs.ansible.com/ansible/latest/collections/all_plugins.html
Steps to reproduce
N/A
Current results
N/A
Suggested feature result
Additional Documentation page for the ansible.eda collection
Additional information
Willing to help contribute and create these files, but I don't know where to place the docs files or to get the templates from
Supporting event source plugins in antsibull-docs (the tool that generates all the plugin/module/role documentation on https://docs.ansible.com/ansible/latest/) should be no big problem once ansible-doc supports them as well.
Chiming in to link a couple of related issues. This issue relies on changes to Ansible core so that ansible-doc can list extensions to the collection structure.