mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-22 14:01:42 -07:00
Mutually reference Windows and non-Windows modules (#25482)
* Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Mutually reference Windows and non-Windows modules To make it easier for Windows or non-Windows users to find the relevant module information, we are mutually referencing both variants in their documentation. We are also adding a special note if a module works on both Windows and non-Windows targets. * Replace 'look at' with 'use', as requested ci_complete
This commit is contained in:
parent
8765eadb30
commit
7d7051fc54
50 changed files with 137 additions and 20 deletions
|
@ -41,6 +41,7 @@ description:
|
|||
your proxy environment for both protocols is correct.
|
||||
- From Ansible 2.4 when run with C(--check), it will do a HEAD request to validate the URL but
|
||||
will not download the entire file or verify it against hashes.
|
||||
- For Windows targets, use the M(win_get_url) module instead.
|
||||
version_added: '0.6'
|
||||
options:
|
||||
url:
|
||||
|
@ -162,6 +163,8 @@ options:
|
|||
# informational: requirements for nodes
|
||||
extends_documentation_fragment:
|
||||
- files
|
||||
notes:
|
||||
- For Windows targets, use the M(win_get_url) module instead.
|
||||
author: Jan-Piet Mens (@jpmens)
|
||||
'''
|
||||
|
||||
|
|
|
@ -30,6 +30,7 @@ short_description: Slurps a file from remote nodes
|
|||
description:
|
||||
- This module works like M(fetch). It is used for fetching a base64-
|
||||
encoded blob containing the data in a remote file.
|
||||
- This module is also supported for Windows targets.
|
||||
options:
|
||||
src:
|
||||
description:
|
||||
|
@ -39,6 +40,7 @@ options:
|
|||
notes:
|
||||
- This module returns an 'in memory' base64 encoded version of the file, take into account that this will require at least twice the RAM as the
|
||||
original file size.
|
||||
- This module is also supported for Windows targets.
|
||||
- "See also: M(fetch)"
|
||||
author:
|
||||
- Ansible Core Team
|
||||
|
|
|
@ -32,6 +32,7 @@ short_description: Interacts with webservices
|
|||
description:
|
||||
- Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE
|
||||
HTTP authentication mechanisms.
|
||||
- For Windows targets, use the M(win_uri) module instead.
|
||||
version_added: "1.1"
|
||||
options:
|
||||
url:
|
||||
|
@ -174,6 +175,7 @@ options:
|
|||
version_added: 2.4
|
||||
notes:
|
||||
- The dependency on httplib2 was removed in Ansible 2.1
|
||||
- For Windows targets, use the M(win_uri) module instead.
|
||||
author: "Romeo Theriault (@romeotheriault)"
|
||||
'''
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue