* manually stub out old porting guides
(cherry picked from commit dedd8fa771)
* manually remove Edit on Github
(cherry picked from commit d5c30abcca)
* add eol banner
(cherry picked from commit 5daf37d89e)
* point all older release pages to devel (#71428)
(cherry picked from commit 3be597419d)
(cherry picked from commit 35abfbf582)
* 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 8a2f069468)
* 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
* 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 bf42f94021)
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 e2d874c744)
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 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 0b585ec4fd)
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 d85f4a443f)
* 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
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
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.
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
.. 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: test 'all' & 'ungrouped' groups created by default
* Mention default groups 'all' & 'ungrouped'
* Update intro_inventory.rst
Minor grammatical edit.
samccann
Matt Clay
Toshio Kuratomi
Scott Butler
John R Barker
anarcat
David Newswanger
Brian Coca
David Moreau-Simard
bobsaintcool
James Cammarata
Raúl Cuza
Alexander Gubin
cclauss
Matt Davis
Dylan Silva
Jason McKerr
Artem Zinenko
Ryan Brown
fhiyo
Aric Renzo
Chris Tooley
Joona Somerkivi
Pilou
Adam Johnson
Marko Stanković
Jeff Gibson
Alan Rominger
Mark Janssen
Andrea Tartaglia