Update include_role description #56001
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The previous description in this statement's description really threw me off, and is IMO ambiguous at best. 'Loads and executes a role as a task dynamically. This frees roles from the roles: directive and allows them to be treated more as tasks.' For reference, I spent a long time trying to make include_role, with a loop, work under a roles: section. It doesn't work, but this documentation and its use of the roles: keyword in the opening, and the phrase '"more" as a task' muddies the waters. +label: docsite_pr
ansibot
added
affects_2.9
bcoca
reviewed
May 2, 2019
bcoca
requested changes
May 2, 2019
ansibot
added
needs_revision
bcoca
requested changes
May 6, 2019
bcoca
approved these changes
May 6, 2019
ansibot
added
core_review
samccann
approved these changes
May 6, 2019
This was referenced May 6, 2019
acozine
added a commit
to acozine/ansible
that referenced
this pull request
May 10, 2019
* Update include_role description to discuss tasks: use The previous description in this statement's description really threw me off, and is IMO ambiguous at best. 'Loads and executes a role as a task dynamically. This frees roles from the roles: directive and allows them to be treated more as tasks.' For reference, I spent a long time trying to make include_role, with a loop, work under a roles: section. It doesn't work, but this documentation and its use of the roles: keyword in the opening, and the phrase '"more" as a task' muddies the waters. +label: docsite_pr (cherry picked from commit 8cb7640)
acozine
added a commit
that referenced
this pull request
May 13, 2019
* Update gcp_container_cluster_facts.py (#55475) : 'state' is not a supported parameter in this module (cherry picked from commit 8c7e38a) * Update win_dns_record.py (#55378): Update examples to show values are strings. (cherry picked from commit 3fd27f0) * sensu_subscription very minor docstring typo (#55675) (cherry picked from commit 2cfaf6e) * Update win_domain_group_membership.py (#55594): add notes regarding a computer object and fixing a typo (cherry picked from commit 3f0900f) * hcloud_server: clarify further for usage of `ssh_keys` (#55713) (cherry picked from commit 6e9379f) * Fix template lookup description (#55557): describe that it returns template content with substituted variables. (cherry picked from commit 9c038b2) * Update ec2_eip_facts.py (#53040): Add several additional examples showing how to filter on tag, how to filter on the EIP allocation id, and how to set a fact using the output. (cherry picked from commit 1e2cbef) * Update ali_instance_facts examples in documentation (#55760) (#55803) (cherry picked from commit 357daff) * Update setup.py (#55871): adds a note on privileges needed on BSD systems to use dmidecode (cherry picked from commit c181e56) * Remove illegal basic provisioning example (#55892): The bare minimum example in the docs (i.e. only supplying name, state, and cluster) results in the error `state is present but all of the following are missing: task_definition, desired_count`. (cherry picked from commit c195645) * clarify docs for rel src state hard (#55972) (cherry picked from commit 0b00220) * correct method docs (#55961) (cherry picked from commit ea57377) * Update sample (#55654): Correct logConfiguration example on the ecs_taskdefinition module. (cherry picked from commit 23ddc77) * add missing exported state do doc string (#56109) (cherry picked from commit ba9f0d5) * package_facts: Trivial docs cleanup (#56015): use the current YAML style and remove unnecessary quotes around `auto`. Signed-off-by: Major Hayden <major@redhat.com> (cherry picked from commit 93d24ef) * Update include_role description (#56001) to discuss tasks: use (cherry picked from commit 8cb7640) * Sync required flags from argument_spec to docs (#56121): arguments for certificate, private_key and password were marked as required in the ArgumentSpec, but not in the documentation. (cherry picked from commit 6b474a1) * updated ec2.py to describe required parameters (#56197): for each option for `state` (cherry picked from commit 5346a5c) * Update os_image documentation (#49705) to show auth details (cherry picked from commit f5326aa)
amuraleedhar
pushed a commit
to amuraleedhar/ansible
that referenced
this pull request
May 21, 2019
* Update gcp_container_cluster_facts.py (ansible#55475) : 'state' is not a supported parameter in this module (cherry picked from commit 8c7e38a) * Update win_dns_record.py (ansible#55378): Update examples to show values are strings. (cherry picked from commit 3fd27f0) * sensu_subscription very minor docstring typo (ansible#55675) (cherry picked from commit 2cfaf6e) * Update win_domain_group_membership.py (ansible#55594): add notes regarding a computer object and fixing a typo (cherry picked from commit 3f0900f) * hcloud_server: clarify further for usage of `ssh_keys` (ansible#55713) (cherry picked from commit 6e9379f) * Fix template lookup description (ansible#55557): describe that it returns template content with substituted variables. (cherry picked from commit 9c038b2) * Update ec2_eip_facts.py (ansible#53040): Add several additional examples showing how to filter on tag, how to filter on the EIP allocation id, and how to set a fact using the output. (cherry picked from commit 1e2cbef) * Update ali_instance_facts examples in documentation (ansible#55760) (ansible#55803) (cherry picked from commit 357daff) * Update setup.py (ansible#55871): adds a note on privileges needed on BSD systems to use dmidecode (cherry picked from commit c181e56) * Remove illegal basic provisioning example (ansible#55892): The bare minimum example in the docs (i.e. only supplying name, state, and cluster) results in the error `state is present but all of the following are missing: task_definition, desired_count`. (cherry picked from commit c195645) * clarify docs for rel src state hard (ansible#55972) (cherry picked from commit 0b00220) * correct method docs (ansible#55961) (cherry picked from commit ea57377) * Update sample (ansible#55654): Correct logConfiguration example on the ecs_taskdefinition module. (cherry picked from commit 23ddc77) * add missing exported state do doc string (ansible#56109) (cherry picked from commit ba9f0d5) * package_facts: Trivial docs cleanup (ansible#56015): use the current YAML style and remove unnecessary quotes around `auto`. Signed-off-by: Major Hayden <major@redhat.com> (cherry picked from commit 93d24ef) * Update include_role description (ansible#56001) to discuss tasks: use (cherry picked from commit 8cb7640) * Sync required flags from argument_spec to docs (ansible#56121): arguments for certificate, private_key and password were marked as required in the ArgumentSpec, but not in the documentation. (cherry picked from commit 6b474a1) * updated ec2.py to describe required parameters (ansible#56197): for each option for `state` (cherry picked from commit 5346a5c) * Update os_image documentation (ansible#49705) to show auth details (cherry picked from commit f5326aa)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Rebased and updated version of #50204.
Clarifies documentation of
include_role: where is it allowed, etc.ISSUE TYPE
COMPONENT NAME
docs.ansible.com
include_role