Commit Graph

45 Commits (c2cc4225c2cabe7a8236569cfe5bfd476e0f4dcb)

Author SHA1 Message Date
Sandra McCann 3ba6348e4d
Galaxy metadata docs update (PR 78280) (#78374)
Co-authored-by: Root <edroot@s1068319.srn.sandia.gov>
Co-authored-by: Emmanuel Ugwu <32464178+ugwutotheeshoes@users.noreply.github.com>
2 years ago
Don Naro 7aada8d499
Docs: Issue 78082 Create playbook guide (#78262) 2 years ago
Don Naro a1444f390d
Docs: Issue 78082 separate tips and tricks in user guide (3/3) (#78103) 2 years ago
Sandra McCann f4ad1c771e
Create reusable role layout snippet for documentation (#78057)
* reuse role structure
* reuse role snippet in role docs
2 years ago
Matt Martz a2eb472fb6
Remove statement about dependencies and includes. Fixes #75055 (#77912) 3 years ago
rwhector bf8e186c68
Example is a single play, not a playbook 3 years ago
Sloane Hertel 5b2334983c
Fix more 'playbook'/'play' conflation (#76387) 3 years ago
Aine Riordan 90de24da7b
Docs: Link to valid data types for role parameters (#76276) 3 years ago
Brian Coca d3ebbef075
correct dedupe scope (#75422) 3 years ago
Aine Riordan 3d081b6ca5
Docs: Edit list of locations to search for roles (#75703)
* Docs: Add playbook base dir to roles search

* Docs: Add link to default roles path
3 years ago
Felix Fontein 81ad125aa6
Fix name of subkey. (#74939) 3 years ago
m0nt3cr1st0 25de07946c
Fix typo on roles documentation (#74696)
##### SUMMARY
Small fix on the roles directory structure documentation

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
David Shrewsbury 8fb54885bf
Role argspec: allow new argument spec file (#74582)
* support separate role argspec file in ansible-doc

* support separate role argspec file in ansible-core

* support both .yml and .yaml extensions on argspec file in ansible-doc

* fix filename building bug and rename some argspec files to test variations

* use yaml extensions from constants

* add superfluous meta/main.yml files to tests

* Update lib/ansible/cli/doc.py

Co-authored-by: Sam Doran <sdoran@redhat.com>

* update docs

* ci_complete

* add changelog and allow for main.yml variations

* add collection role testing

Co-authored-by: Sam Doran <sdoran@redhat.com>
4 years ago
Alicia Cozine 05662fd2ab
Docs: clarify role docs - vars vs params, dependencies (#74104) 4 years ago
David Shrewsbury c8ee186e11
Remove warning about role validation with deps (#73653)
* Remove warning about role validation with deps

* add changelog

* update cl
4 years ago
David Shrewsbury f0ec10dbc3
Role arg spec validation implementation (#73152)
* Initial import of modified version of alikins' code
* Add unit testing for new Role methods
* Fix validate_arg_spec module for sanity test. Add test_include_role_fails.yml integration test from orig PR.
* Add testing of suboptions
* Use new ArgumentSpecValidator class instead of AnsibleModule
* fix for roles with no tasks, use FQ name of new plugin
* Add role dep warning
4 years ago
Matt Martz 97765f4ebd
Role duplicates docs updates (#72666)
* Change example to use role params to represent the documented outcome. Fixes #68922

* Add notes about how vars vs role params affect variable scoping, and how lazy evaluation and role-deduplicating is affected. Fixes #72650

* link to term
4 years ago
Badhreesh a47eafa581
Update playbooks_reuse_roles.rst (#71880)
Change "vars_files" to "vars, files" under the Roles heading
4 years ago
Andrew Klychkov 7a0a2f188b
Docsite: improve user_guide/playbooks_reuse_roles (#71857)
* Docsite: improve user_guide/playbooks_reuse_roles

* fix
4 years ago
esmersmith a34043c6be
Changed all_modules references to list_of_collections in the documentation (#71656) 4 years ago
Abhijeet Kasurde 0b16c0a8c7
user_guide: Fix reuse role examples (#71440)
Fixes: #53919

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
4 years ago
David M. Lee 3e4377300b
Explain duplicate checks includes tags and when (#68183)
##### SUMMARY
Per #67913, when comparing dependencies, Ansible takes into account parameters, tags and the when clause in determining whether a role is a duplicate or not.

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
4 years ago
Sayee 4f0bd5de38
a few writing style updates (#71212) 4 years ago
Liviu Chircu cb9336ab6d
Docs: Fix typo (#71119)
Fix typo
4 years ago
Alicia Cozine db354c0300
Docs: User guide overhaul, part 5 (#70307) 4 years ago
Brian Coca 5d3d097de3
more correct info about role main.yml (#70326)
fixes #40496
4 years ago
Alicia Cozine 6fffb0607b WIP: Docs: User guide overhaul, part 4 (#69266)
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
5 years ago
Jonas DOREL 29edcdcf5b
Add library in role directory structure (#67030)
* Add library directory to the list of directories in a role
5 years ago
Sam Doran c8568a5c94
Add documentation about vars used in roles at the play level (#66907) 5 years ago
Alicia Cozine 0b503f6057 Docs: User Guide overhaul, part 3 (#66371) 5 years ago
Wojciech Sciesinski 95aef88a45 Update indentation used in the code examples, unify empty lines (#65346) 5 years ago
Alicia Cozine d4f0bc183e removes last :doc: links in user guide (#58433)
* removes last :doc: links in user guide
5 years ago
Evgeni Golov ace38a2646 two indentation fixes in playbooks_reuse_roles.rst (#51934)
+label: docsite_pr
6 years ago
branen 88029a73d6 Correct docsite typos: it's -> its (#50812) 6 years ago
Jonas DOREL d9ae906772 Add galaxy.html#dependencies link (#49984)
* Add galaxy.html#dependencies link

+label: docsite_pr
6 years ago
Tim Burke 6e43f9fe8f Fix ReST formatting for Galaxy docs link (#49575) 6 years ago
Andreas Krüger e2bba149d6 playbooks_reuse_roles.rst long and shorthand example actually made equivalent. (#48339) 6 years ago
Brian Coca 44510448b0 prefer ansible_facts namespace and dict notation (#44980)
* prefer ansible_facts namespace and dict notation

* fixed mistranslation
6 years ago
Ritesh Puj ff654ccfe8 replaced 'ansible_os_platform' to 'ansible_os_family' (#44676)
replaced 'ansible_os_platform' to 'ansible_os_family' as 'ansible_os_platform' variable is no longer available.
6 years ago
Andreas Olsson 1a11cecaef Prefer https:// links in the docs site
All the changed urls are availible by way of https://. Most of them
already redirect.
6 years ago
Alexandre Vicenzi 1dafd92c8e Fix Ansible Galaxy documentation link. (#42316)
More info: https://github.com/ansible/galaxy/issues/830
6 years ago
Greg DeKoenigsberg e5ccdaec88 Better Galaxy description for role reuse (#40557)
* Better Galaxy description for role reuse

* update per gundalow review
7 years ago
Brian Coca c62551c1b0 Update role doc examples (#37844)
* fix role examples

- also fixed issue with overload of 'name', fixes #37836
- attempted to clarify tag inheritance/application

* Typo fix
7 years ago
scottb 381359a8f8
Doc build warning/broken link clean-a-palooza (#37382)
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
7 years ago
scottb 373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
7 years ago