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

Collection note should indicate that further dependencies may be required. #23

Closed
samccann opened this issue Aug 11, 2022 · 1 comment · Fixed by #24
Closed

Collection note should indicate that further dependencies may be required. #23

samccann opened this issue Aug 11, 2022 · 1 comment · Fixed by #24

Comments

@samccann
Copy link
Contributor

Can't transfer the issue from ansible/ansible#74195 so doing the copy-pasta:

I am a contributor to the ansible.azcollection project. In order for those modules to execute, many azure specific packages must be installed via pip.
At the top of all of the online documentation for modules, there is a "Note" banner on installing the collection, example
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_storageaccount_module.html
That banner is added to every module's doc in all of the collections in that doc site.

The problem we're running into is that newer users read that banner and believe that it satisfies all dependencies by doing the 'ansible-galaxy collection install ${collection} ' . Could some additional text be added to indicate that there may be further dependencies, and that they should click on the collection link to see the collection specific docs?

I would attempt a PR myself, but I have no idea how the docs are composed or where the banner message is being pulled from. If this is not the correct repo to report the issue against, let me know and I'll resubmit there.

@felixfontein
Copy link
Collaborator

See #24 for a possible way to do this. Basically if there is a requirements section for the plugin/module, mention that additional requirements are needed and link to that section.

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

Successfully merging a pull request may close this issue.

2 participants