summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Document boolean default value treatment (#30062)Toshio Kuratomi2017-09-141-0/+2
| | | | | | | | | | | | * Consistency and document treatment of default bool values * Document that default bool values can be any Ansible recognized bool. choose the one that reads better in context * For fragments used by the copy module, make bool types use type=bool and not choices * Edit for clarity (cherry picked from commit 8a2f069468e1d072f4b57c19fab964d3626db5f8)
* CSS for versioned docs TOC header.Scott Butler2017-08-312-8/+20
|
* Updated CSS for versioned docs - back ported from level.Scott Butler2017-08-311-0/+6
|
* Fixed index so TOC points to new community landing page.Scott Butler2017-08-311-1/+1
|
* Bulk rst/community backport (#28896)John R Barker2017-08-319-0/+554
|
* fix two broken absolute links (#28766)anarcat2017-08-301-11/+11
| | | | | | | | * fix two broken absolute links instead of using absolute links, we use normal Sphinx mechanics to make sure those links work portably in the future * reformat list so paragraphs are properly indented
* fixed a syntax problem that was preventing a warning box from being displayedDavid Newswanger2017-08-101-19/+18
| | | | (cherry picked from commit ebb1d75ee088d0bd1e604b0011a270cd4968e50c)
* Fix ROADMAP rst formatToshio Kuratomi2017-08-071-1/+1
|
* 2.3portingguide (#27671)John R Barker2017-08-075-62/+336
| | | | | | | | | | | | | | | | | | | | | | | | | | | * Docs porting guides 2.0 & 2.3 (#27632) * Create new "Porting Guide" section Create new landing page Add porting_guide_2.3 * correct CHANGELOG * Document blocks * Document named blocks * OpenBSD & async action plugins * OpenBSD & async action plugins * versioadded for name * review comments (cherry picked from commit df58d943d37b69bb49dcddb42c4a1102523ecfe9) * Correct merge
* corrected with_dict exampleBrian Coca2017-08-071-2/+1
| | | | | | fixes #17636 (cherry picked from commit 001be55ef02052cff7820ddb2e1c0d7431f79a7a)
* Fixes to pip with git install instructionsToshio Kuratomi2017-08-071-3/+1
| | | | | | | | | * use git+https:// in the example url because not everyone will have ssh keys registered on github * Remove the link to the github tarballs as they do not work. users can use releases.ansible.com instead. (cherry picked from commit bf42f94021abb54b8a68911c96e6a8bb5e41e1bf)
* Improve release and development cycle documentationDavid Moreau-Simard2017-08-074-59/+139
| | | | | | | | | | | This commit: - Adds a table highlighting the status of each version and provides a link to each major release's changelog - Re-inforces how stable versions are maintained and for how long - Moves this documentation out of the developer tree (this is interesting for users too!) while keeping a link there. (cherry picked from commit e2d874c744698d97b603262a2f8a4d4d44c76782)
* Add module_utils example next to library examples (#25390)Toshio Kuratomi2017-08-071-1/+4
| | | | (cherry picked from commit 37e757286dade76b0305667d508114d6387c6a3d)
* <doc/dev/modules: Fix an RST typo into external link> (#27615)bobsaintcool2017-08-031-1/+1
| | | Make a link a valid external hyperlink targets.
* docs: fix community meetings link (#27264) (#27586)John R Barker2017-08-017-42/+40
| | | (cherry picked from commit 9c50933a80f39efb1f82b8daab86969a329de53f)
* Bulk dev_guide from devel to 2.3 (#27205)John R Barker2017-07-2420-67/+1768
| | | | | | * Bulk dev_guide from devel to 2.3 * Scot's feedback
* Bulk import network doc changes from devel to 2.3 (#27204)John R Barker2017-07-232-2/+477
|
* Adds documentation of implicit regex match removal (#24934) (#25255)John R Barker2017-06-011-0/+3
| | | | regex_replace has a implicit parameter for `replacement` and thus can remove the matched string (cherry picked from commit aa9ea3d43af43118b9353d6c7bf060acd916122e)
* Limit sphinx version on python 2.6. (#24678)Matt Clay2017-05-174-10/+11
| | | | | | | * Limit sphinx version on python 2.6. * Fix issues identified by rstcheck. (cherry picked from commit 9178e176b554fe260fb25743aaeb4bb9079d34f5)
* Fixing security issue with lookup returns not tainting the jinja2 environmentJames Cammarata2017-05-081-0/+14
| | | | | | | | | | | | | | | CVE-2017-7481 Lookup returns wrap the result in unsafe, however when used through the standard templar engine, this does not result in the jinja2 environment being marked as unsafe as a whole. This means the lookup result looses the unsafe protection and may become simple unicode strings, which can result in bad things being re-templated. This also adds a global lookup param and cfg options for lookups to allow unsafe returns, so users can force the previous (insecure) behavior. (cherry picked from commit 72dfb1570d22ac519350a8c09e76c458789120ed)
* Add ansible-vault encrypt_string doc (#24147)Raúl Cuza2017-05-032-2/+39
| | | | * Add documentation on 'ansible-vault encrypt_string'
* Add guide for Packet host (#21346) (#23807)John R Barker2017-04-202-0/+310
| | | | | | | | | | | * Add guide for Packet host * incorporate feedback from Packet * Format headings according to Python doc guide * fixed rstcheck issues in packet guide (cherry picked from commit 0b585ec4fde9f11c7dd633f0119e35ffe774e141)
* Fix example fact(ansible_default_ipv4.address) for delegated_factsAlexander Gubin2017-04-191-1/+1
| | | | (cherry picked from commit d04a5246de165ef52c33693cf0a8346f07e90d59)
* Add rstcheck to ansible-test and correct issues. (#23550)Matt Clay2017-04-134-7/+7
| | | | | | | | | * Add rstcheck to ansible-test. * Fix rst code-block languages and syntax errors. * Fix rst inline literals. * Update python 2 code block to pass tests on py 3. (cherry picked from commit cb1f57d4e54012ea17f35e17df2462d9c6c14981)
* Update the comments around Python 3cclauss2017-04-131-4/+3
| | | | | [Enterprise Linux 5 is at the end of "End of Production 3 phase"](https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux#Product_life_cycle) so that is no longer a reasonable reason to wait. Also removed the comments about [Python 3 not being mainstream](http://python3wos.mybluemix.net/201). Perhaps a link to https://docs.ansible.com/ansible/python_3_support.html would also be a useful addition to this question. (cherry picked from commit 6314169afdc10d6d73cfe341b2d73576b1718b46)
* mark runas become method experimental (#23235)Matt Davis2017-04-031-3/+3
| | | | | Due to the number of "real world" caveats in the current runas become method, it was agreed that we'd warn that it's experimental on use. A potential future version based on LogonUser/CreateProcessAsUser will have very different requirements and limitations. (cherry picked from commit d85f4a443fb4e449b1b8c2750fd80f2949b1a8ac)
* fixed passwordstore lookup examplesBrian Coca2017-03-211-6/+6
| | | | | | | plugin was renamed before acceptance, but examples kept original name fixes #22735 (cherry picked from commit 6a2985dd3cdbc967ff7d7e9625af1d517a425a33)
* cherry pick changes to modules and docs for 2.3 rc (#22815)Dylan Silva2017-03-202-10/+7
| | | | | | | | | | | | | | * Dropped openwrt module from curated to community (#22657) * changed supported_by from curated to community (#22656) * Changed supported_by from curated to community (#22654) * Updates to docs for metadata. (#22667) * Updates to docs for metadata. * Update developing_modules_documenting.rst
* New metadata 1.0 (#22587)Toshio Kuratomi2017-03-142-21/+23
| | | | | | | | | | | | | | | | Changes to the metadata format were approved here: https://github.com/ansible/proposals/issues/54 * Update documentation to the new metadata format * Changes to metadata-tool to account for new metadata * Add GPL license header * Add upgrade subcommand to upgrade metadata version * Change default metadata to the new format * Fix exclusion of non-modules from the metadata report * Fix ansible-doc for new module metadata * Exclude metadata version from ansible-doc output * Fix website docs generation for the new metadata * Update metadata schema in valiate-modules test * Update the metadata in all modules to the new version
* Stricter module documentation validation (#22353)John R Barker2017-03-132-20/+67
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Raise the bar for module `DOCUMENTAION` This validator update was used to find the issues in https://github.com/ansible/ansible/pull/22297/files **Validation** * Updated Validation and docs to enforce more (items fixed in https://github.com/ansible/ansible/pull/22297/files) * Use `suboptions` to document complex options * Validate module name * Validate deprecated modules have correct ANSIBLE_METADATA **Module Documentation Generation** * Document `suboptions:` Example https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 * Tidy up HTML generation (valid HTML, no empty lists, etc) **Documentation** * Clarify the steps for deprecating a module * Use correct RST headings * Document `suboptions:` (options) * Document `contains:` (returns) **Details** The aim is to get this (and corresponding module updates) complete by the time `devel` becomes `2.4`, as this allows us to raise the bar for new modules Example `suboptions` https://gist.github.com/gundalow/4bdc3669d696268328ccc18528cc6718 The aim is to get this PR integrated into `devel` *before* we branch `stable-2.3`, this will allows us to: * Raise the bar for new modules in 2.4 * Ensure the generated module documentation for 2.3 and higher is improved, important as we will be doing versioned docs moving forward.
* Update ROADMAP_2_3.rstJason McKerr2017-03-131-1/+1
|
* Fix bug in 'Building A Simple Module' doc (#22447)Artem Zinenko2017-03-101-1/+1
|
* Update roadmap for Amazon ModulesRyan Brown2017-03-091-5/+5
|
* Add document about connecting to localhost (#20534)fhiyo2017-03-081-1/+16
| | | | | | | | | | | | * Add document about connecting to localhost * Update intro_getting_started.rst * Update intro_getting_started.rst Edited. * Added description about ansible_python_interpreter
* Add manpage for ansible-console. (Closes: #16244) (#16245)Harlan Lieberman-Berg2017-03-081-0/+261
| | | | | | * Add manpage for ansible-console. (Closes: #16244) * Mark host as an optional field in ansible-console.1
* Fix docs type (#22405)John R Barker2017-03-081-1/+1
| | | Fix docs typo
* fixed ungrouped definitionBrian Coca2017-03-071-2/+1
|
* Standardizing syntax for 'Playbook Loops' documentation (#20863)Aric Renzo2017-03-061-54/+147
|
* Fix Docs build issues (#22295)John R Barker2017-03-057-42/+44
| | | | | | | | * restore network docs fragments * Fix RST errors * code-block formatting
* Add some additional value quoting examples (#20464)Chris Tooley2017-03-051-0/+10
| | | The existing examples in the "Gotchas" section were rather simple. Expanded upon those to add some additional clarity around how the quoting in YAML works.
* Added example of referring to AWS-credentials (#21560)Joona Somerkivi2017-03-051-0/+7
| | | | | | | | | | * Added example of referring to AWS-credentials .. when they're stored in variables. Spent few hours trying to figure out why credentials from vault/variables were not used. * Update guide_aws.rst Edited for grammar.
* Inventory default groups 'all' and 'ungrouped': add tests and documentation ↵Pilou2017-03-051-0/+9
| | | | | | | | | | | | (#21728) * inventory: test 'all' & 'ungrouped' groups created by default * Mention default groups 'all' & 'ungrouped' * Update intro_inventory.rst Minor grammatical edit.
* doc: Document --syntax-check flag for ansible-playbook (#22256)Adam Johnson2017-03-041-0/+3
| | | It wasn't previously documented outside of the help / manpage, which made it less discoverable.
* Improve YAMLSyntax/Gotchas (#21575)Marko Stanković2017-03-031-2/+10
| | | | | | | | | | * Improve YAMLSyntax/Gotchas Colons don't need to be quoted unless when followed by a space or the end of the line * Update YAMLSyntax.rst Minor edit.
* ansible_winrm_kerberos_delegation (#22113)Jeff Gibson2017-03-031-0/+1
| | | Add a note of how to turn on delegation when using kerberos.
* Update dead support link (#22212)Alan Rominger2017-03-021-2/+2
| | | | | | | | | | * Update dead support link Visit https://www.ansible.com/, and you'll find the support link points to this URL, https://access.redhat.com/products/ansible-tower-red-hat/. The current link is a dead link. * update github code blocks link
* Update documentation for passwordstore lookup (#21448)Mark Janssen2017-03-021-0/+42
| | | | | | | | | | | | | | * Update documentation for passwordstore lookup * Style fixes * Style fixes * Reword introduction text * Update playbooks_lookups.rst Minor tweaks.
* Clarified when control_path is ignored (#20968)Andrea Tartaglia2017-03-021-2/+2
|
* Bumping docs footer copyright year (#22210)Chris Alfonso2017-03-021-1/+1
|
* Fix variable precedence of INI/script vars to be in-line with docs.James Cammarata2017-03-021-8/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit also adds a new test script (ansible-var-precedence-check.py in code-smell/) to provide us with another line of defense against precedence bugs going forward. The precedence docs state that the INI vars have a lower precedence than group/host vars files for inventory and playbooks, however that has not been the case since 2.0 was released. This change fixes that in one way, though not exactly as the docs say. The rules are: 1) INI/script < inventory dir < playbook dir 2) "all" group vars < other group_vars < host_vars So the new order will be (from the test script mentioned above): 8. pb_host_vars_file - var in playbook/host_vars/host 9. ini_host_vars_file - var in inventory/host_vars/host 10. ini_host - host var inside the ini 11. pb_group_vars_file_child - var in playbook/group_vars/child 12. ini_group_vars_file_child - var in inventory/group_vars/child 13. pb_group_vars_file_parent - var in playbook/group_vars/parent 14. ini_group_vars_file_parent - var in inventory/group_vars/parent 15. pb_group_vars_file_all - var in playbook/group_vars/all 16. ini_group_vars_file_all - var in inventory/group_vars/all 17. ini_child - child group var inside the ini 18. ini_parent - parent group var inside the ini 19. ini_all - all group var inside the ini Fixes #21845
View Lorry Controller Status