Commit graph

2427 commits

Author SHA1 Message Date
Alicia Cozine
b765d3799b
update backporting instructions to reflect new latest stable branch, some edits ()
Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com>
2021-04-30 11:42:03 -04:00
Matt Clay
a30c55f68a Remove deprecated common.removed module_util.
Tests have been updated to reflect its removal as well.
2021-04-29 16:07:56 -07:00
Toshio Kuratomi
112b175f17
Update the porting guide for a new ansible version () 2021-04-29 10:03:21 -04:00
Christian Fetzer
f194108a26
docs: Improve documentation for regex_search,replace,findall ()
Improve the documentation for regex_search by adding a few more
realistic examples such as showing how to extract only parts of a
string by using regex groups.

Extend regex_findall and regex_replace by an example that includes
the multiline and ignorecase parameters.
2021-04-28 08:45:01 -04:00
Mark Chappell
c387b318a6
AWS: update reference to auto-retrying ResourceNotFound ()
AWS Dev Guidelines: update reference to auto-retrying ResourceNotFound

Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-04-28 09:59:12 +05:30
Bill Nottingham
34c9ed8a28
Product-related updates. () 2021-04-27 16:19:57 -05:00
Alicia Cozine
9d9b08bece
fix spacing to fix header, reorg contributing page ()
Co-authored-by: John R Barker <john@johnrbarker.com>
2021-04-27 10:41:10 -04:00
Lidiane Taquehara
f97787ca74
Update argcomplete docs links on installation guide ()
Link on installation docs is outdated. Switch to currently docs at: https://kislyuk.github.io/argcomplete/
2021-04-27 09:40:37 -05:00
Sandra McCann
d1e6ee7b21
update changelog links and release-maint page () 2021-04-27 09:33:21 -05:00
Abhijeet Kasurde
8d499bbc83
Update Kubernetes collection name in docs () 2021-04-27 19:00:03 +05:30
Mark Chappell
63afb33d86
Use is_boto3_error_code in 'standard' example ()
Use is_boto3_error_code in 'standard' example rather than e.response['Error']['Code'] ()

Co-authored-by: Sloane Hertel <shertel@redhat.com>
2021-04-27 17:49:00 +05:30
Mark Chappell
cf08c23b4f
Update AWS dev guides to use collections utils and fragments () 2021-04-27 17:34:49 +05:30
jakelevinez
ddfc648d37
Update VMware library installation docs ()
Depending upon OS/distro, please use pip/pip3.
2021-04-27 15:19:03 +05:30
dhx-mike-palandra
c2985c491b
Update complex_data_manipulation.rst () 2021-04-27 14:04:48 +05:30
Ernst Oudhof
7ca5dede97
Add weos4 network platform to documentation ()
* Add weos4 network platform to documentation

* Fix small format issues
2021-04-23 23:52:14 +02:00
Alicia Cozine
c90922ee36
Docs - Split Developing collections page, add info on optional module_utils ()
*
2021-04-23 17:03:46 -04:00
Alexandre Garnier
8698855ffd
Case-insensitive set theory filters ()
Fixes 

* Fix call to 'unique(case_sensitive=False)' triggering error when falling back to Ansible's version which **is** case-sensitive
* Test multiple situations of 'unique' filter errors with fallback not handling specific parameters

Signed-off-by: Rick Elrod <rick@elrod.me>
Co-authored-by: Rick Elrod <rick@elrod.me>
2021-04-23 12:44:43 -05:00
Hublerho
e6a5245d60
Using "~" instead of "+" for concatination ()
Changed FAQ examples to conform with the Jinja documentation:
If both values on either side of a plus/+ are numbers, they will be added whereas using "~" will convert all operands into strings and then concatenate them. Closes .
2021-04-23 12:44:09 -05:00
Alex Willmer
c295de661c
Correct splitext() description, and example ()
`splitext()` returns a 2-tuple of strings, and the last element of the return value includes the `.`
2021-04-22 15:40:58 -05:00
Sam Doran
fdbef02923
Update docs on working on docs ()
* Fix the Makefile's htmlsingle command.
Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
2021-04-21 15:15:27 -04:00
Toshio Kuratomi
4c79dd16be
Update the porting guide for a new ansible version () 2021-04-21 10:23:31 -04:00
Sam Doran
2cbfd1e350
Add porting guide and documentation for changes to argument spec validation ()
* Add ArgumentSpecValidator to docs
* Improve docs for ArgumentSpecValidator
* Document removal of private methods

* Update module_utils documentation
    - Add docs for argument spec classes as well as validation and parameters files.
    - preserve the order in the source for errors.py
    - document DEFAULT_TYPE_VALIDATORS so it can be referenced elsewhere
    - fix automodule directive for validation.py

* Update docs in arg_spec and paremeters
    - This improves the generated documentation.

* Document breaking changes in porting guide.
* Update formatting in porting guide and add a Deprecated section
* Fine tune module_utils documentation


* Move instance docstring to the __init__ method
  Remove optional description since it fails the sanity test and I am not 100% it is valid anyway.

* Remoe incorrect parameter from docstring
  This was changed a while ago but wasn't removed from the docstring.

* Use attr rather than attribute
  The py:attribute: domain only exists in newer Sphinx >= 3.1.

* Improve documentation on exceptions
* Final pass
    - use args/kwargs instead of param
    - fix formatting errors that didn't display examples correctly
    - format TypeErrors so they are referenced as classes
    - specify complex types
2021-04-20 15:40:53 -04:00
Abhijeet Kasurde
6e56e72d99
vmware: Add a note about known issue ()
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2021-04-20 14:11:45 -04:00
sry9681
c0cc574e65
Update lookup.rst ()
Document that users must pass `allow_unsafe=True` as an option in the lookup to allow templating, with a note about security implications.

Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
2021-04-20 12:54:54 -05:00
ml
c9c84594d8
Docs: Fix k8s_config_resource_name YAML example ()
The `name` key should be beneath `metadata`:
2021-04-20 13:37:44 -04:00
Abhijeet Kasurde
9ed0e37e53
Add a link to Jinja 2 templates ()
Added a link to Jinja 2 templates in playbooks_templating documentation page.
Fixes: 

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2021-04-20 12:14:08 -05:00
yuri
5f391a72ee
Update playbooks_filters.rst ()
##### SUMMARY
Make the `random` filter description more clear.
2021-04-20 11:59:16 -04:00
schurzi
5e5bfa8116
remove deprecated ansible.module_utils._text from documentation ()
According to comment in ansible.module_utils._text it is deprecated and
should not be used. This is now reflected in the documentation.
2021-04-20 11:53:27 -04:00
Baptiste Mille-Mathias
99a2b5f300
Provide results to examples () 2021-04-20 11:52:54 -04:00
David Shrewsbury
d44eb03f49
Remove include from tests () 2021-04-20 11:19:29 -04:00
daeseokyoun
9369bd6ca1
correct how to install Docker SDK for Python ()
* docs: correct guide for the latest Docker SDK for Python
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Daeseok Youn <daeseok.youn@navercorp.com>
Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com>
2021-04-20 11:03:30 -04:00
Brian Coca
7b39ee361d
corrected epmhasis line ()
need to be careful when adding lines as you create a different offset
2021-04-20 09:38:06 -05:00
Matt Martz
17237c1d88
Deprecate Py2.6 support for target nodes () 2021-04-16 11:42:29 -05:00
Toshio Kuratomi
ee38202fc0
Update the porting guide for ansible package 4.0.0 alpha4 () 2021-04-14 16:42:28 -04:00
Brian Coca
270f109bb3
fix see_also formatting () 2021-04-13 11:51:39 -04:00
Rick Elrod
19aeb4706d
[conditional] Remove support for bare variables ()
Change:
- Variables used in ``when`` conditionals are no longer parsed and
  attempted to be converted to booleans. All non-empty strings are
  considered true (empty strings, false).

Test Plan:
- Updated existing tests
- Added a bunch of new tests with various kinds of truthy/falsy
  values.

Tickets:
- Fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2021-04-13 11:12:10 -04:00
Matthew Cengia
c7473828c7
Docs: Remove duplicate word ()
The word "to" was erroneously used twice consecutively.

Signed-off-by: Matthew Cengia <mattcen@mattcen.com>
2021-04-11 05:50:36 -05:00
Rick Elrod
d7df8a4484
[cron] Remove deprecated features ()
Change:
- Require name always
- Drop 'reboot' parameter in favor of 'special_time: reboot'

Test Plan:
- CI

Tickets:
- fixes 

Signed-off-by: Rick Elrod <rick@elrod.me>
2021-04-08 15:50:27 -04:00
Matt Martz
09c8faca9f
Add 2.12 roadmap () 2021-04-06 12:43:38 -05:00
Alicia Cozine
05662fd2ab
Docs: clarify role docs - vars vs params, dependencies () 2021-04-06 11:24:28 -04:00
Rick Elrod
3a74f7ea22
prep for 2.12 version bump ()
* prep for 2.12
* Add 2.12 deprecations and sort ignore.txt list.

Signed-off-by: Rick Elrod <rick@elrod.me>
2021-04-05 16:56:53 -05:00
Toshio Kuratomi
112a7718c6
Porting guide update for ansible-4.0 alpha3 () 2021-03-30 18:20:11 -05:00
Toshio Kuratomi
47ffa27416
Update the porting guide for a new ansible version () 2021-03-30 14:13:42 -05:00
Baptiste Mille-Mathias
6b33864a2c
Clarify tags on tasks are applied with OR and not AND ()
Co-authored-by: flowerysong <junk+github@flowerysong.com>
2021-03-30 11:05:54 -04:00
Felix Fontein
af7f3fc266
Revert "Add duplicated set filter and documentation ()" ()
This reverts commit 99a6627c60.

* ci_complete
2021-03-27 20:28:28 -05:00
Baptiste Mille-Mathias
99a6627c60
Add duplicated set filter and documentation ()
Co-authored-by: Kerry <kerry@flatline-studios.com>
2021-03-27 00:18:55 +01:00
Alicia Cozine
c66cff444c
documents the use of ansible.legacy () 2021-03-25 16:36:46 -04:00
Leandro Scardua
5dbcaa4c01
Update version on FreeBSD ()
##### SUMMARY
<!--- Your description here -->
On the main freebsd change, and no the version: py37-ansible

##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
2021-03-25 16:30:52 -04:00
Sandra McCann
59c61bc88a
update docs to uninstall ansible-base on upgrade () 2021-03-25 15:21:37 -05:00
sgpinkus
2abb2d3f17
Update playbooks_variables.rst. To say you can define variables within a playbook is somewhat misleading. Variables are defined within plays and are only visible within the play they are defined in *not* the entire playbook. There is no way to define vars to have strictly playbook scope. ()
+label: docsite_pr
2021-03-25 16:05:50 -04:00