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 #160

Open
bontreger opened this issue Aug 8, 2023 · 2 comments
Labels
bug Something isn't working
Milestone

Comments

@bontreger
Copy link

bontreger commented Aug 8, 2023

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

Depends-On: ansible-community/antsibull-docs#304
Depends-On: ansible-community/antsibull-docs#303
Depends-On: ansible-community/antsibull-docs#305

@felixfontein
Copy link

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
Copy link

oraNod commented Mar 11, 2024

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.

ansible/ansible#80508 and ansible/ansible#75109

@ssbarnea ssbarnea added the bug Something isn't working label Aug 19, 2024
@ssbarnea ssbarnea added this to the v2.0.0 milestone Aug 19, 2024
@ssbarnea ssbarnea pinned this issue Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants