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

Updated the ansible-galaxy docs #52070

Merged
merged 3 commits into from
Feb 12, 2019
Merged

Updated the ansible-galaxy docs #52070

merged 3 commits into from
Feb 12, 2019

Conversation

anis016
Copy link
Contributor

@anis016 anis016 commented Feb 12, 2019

Updated the documentation that reflects the default branch that will be used for the version option in ansible-galaxy.

+label: docsite_pr

SUMMARY

Updated the documentation that reflects the default branch that will be used for the version option in ansible-galaxy. Fixes #51748

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs.ansible.com

ADDITIONAL INFORMATION

<!--- Your description here -->

Updated the documentation that reflects the default branch that will be used for the `version` option in ansible-galaxy.

+label: docsite_pr
@Akasurde
Copy link
Member

@anis016 Thanks for the PR. I can see this block code

self.version = 'master'
where it set it master. So might want to rephrase the documentation.

@ansibot
Copy link
Contributor

ansibot commented Feb 12, 2019

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 12, 2019
As per the code (https://github.com/ansible/ansible/blob/6d4307377fca671e2abba082f00167c2b63beedf/lib/ansible/galaxy/role.py#L237)[ansible/galaxy/role.py] Defaults to the branch set as a default in the repository otherwise defaults to the master.
@anis016
Copy link
Contributor Author

anis016 commented Feb 12, 2019

@Akasurde thank you! I checked the code and updated the documentation accordingly.

Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

Thanks for the addition! I added a minor comma nit that you should be able to 'accept suggestion' to include it in this patch.

docs/docsite/rst/reference_appendices/galaxy.rst Outdated Show resolved Hide resolved
Co-Authored-By: anis016 <anis016@users.noreply.github.com>
@dagwieers dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Feb 12, 2019
@samccann samccann merged commit bf20c41 into ansible:devel Feb 12, 2019
@samccann
Copy link
Contributor

Thanks @anis016 for the ansible documentation fix!

@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite_pr This PR is created from documentation using the "Edit on GitHub" link. 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.

Docs: Clarify ansible-galaxy docs
5 participants