Skip to content

new: documentation update for galaxy usr guide #78649

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

Merged
merged 1 commit into from
Sep 1, 2022

Conversation

cloudguruab
Copy link
Contributor

@cloudguruab cloudguruab commented Aug 25, 2022

SUMMARY

Trying to understand how to specify which path to use to install a galaxy collection. It would be helpful to explain (1) all of the available parameters, (2) what they do, and (3) what their defaults are.

Fixes #78604

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Galaxy user guide documentation update

ADDITIONAL INFORMATION

Link to original issue: #78604

@ansibot
Copy link
Contributor

ansibot commented Aug 25, 2022

Thanks for your Ansible docs contribution! We talk about Ansible documentation on maxtrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

click here for bot help

@ansibot ansibot added affects_2.14 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Aug 25, 2022
@@ -492,3 +492,9 @@ Use ``remove`` to delete a role from *roles_path*:
Shareable collections of modules, playbooks and roles
:ref:`playbooks_reuse_roles`
Reusable tasks, handlers, and other files in a known directory structure

Perform other related operations
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not put it under that .. seealso:: above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Making changes now

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
@cloudguruab cloudguruab requested a review from webknjaz August 26, 2022 19:12
@webknjaz webknjaz requested a review from samccann August 27, 2022 16:13
@mkrizek mkrizek removed the needs_triage Needs a first human triage before being processed. label Aug 30, 2022
@samccann samccann merged commit b8abcd1 into ansible:devel Sep 1, 2022
@samccann
Copy link
Contributor

samccann commented Sep 1, 2022

Thanks @cloudguruab for the Ansible docs fix and welcome to Ansible!

samccann pushed a commit to samccann/ansible that referenced this pull request Sep 1, 2022
sivel pushed a commit that referenced this pull request Sep 1, 2022
Co-authored-by: Adrian Brown <ap.brown011@gmail.com>
@ansible ansible locked and limited conversation to collaborators Sep 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.14 core_review In order to be merged, this PR must follow the core review workflow. docs_only All changes are to files within the docs/docsite/ directory docs This issue/PR relates to or includes documentation. has_issue new_contributor This PR is the first contribution by a new community member. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ansible/docs/docsite/rst/galaxy/user_guide.rst lacks documentation for the -p parameter
5 participants