Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
3 tasks done
bontreger opened this issue Jul 28, 2023 · 2 comments

Comments

@bontreger
Copy link

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • 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

@Alex-Izquierdo
Copy link
Contributor

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

@bontreger
Copy link
Author

Cross-posted the issue to event-driven-ansible project ansible/event-driven-ansible#160

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants