search

ansible / event-driven-ansible

Ansible Collection for EDA
https://ansible.readthedocs.io/projects/ansible-eda/
Apache License 2.0
274 stars 106 forks source link

RFE: Documentation. Document Event Source plugins in a manner similar to the ansible collection index #160

Open bontreger opened 1 year ago

bontreger commented 1 year ago

CROSS POSTED from https://github.com/ansible/ansible-rulebook/issues/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

Depends-On: https://github.com/ansible-community/antsibull-docs/issues/304 Depends-On: https://github.com/ansible-community/antsibull-docs/issues/303 Depends-On: https://github.com/ansible-community/antsibull-docs/issues/305

felixfontein commented 1 year ago

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.

oraNod commented 7 months ago

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.

https://github.com/ansible/ansible/issues/80508 and https://github.com/ansible/ansible/issues/75109