ansible-rulebook
ansible-rulebook copied to clipboard
RFE: Documentation. Document Event Source plugins in a manner similar to the ansible collection index
Please confirm the following
- [X] I agree to follow this project's code of conduct.
- [X] I have checked the current issues for duplicates.
- [X] I understand that ansible-rulebook is open source software provided for free and that I might not receive a timely response.
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
Sugested 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
Indeed we need to improve the docs for source plugins as well as meet the requirements for ansible-modules (and be able to see the docs with ansible-doc
) I would say this is more a task for https://github.com/ansible/event-driven-ansible
Cross-posted the issue to event-driven-ansible project https://github.com/ansible/event-driven-ansible/issues/160