mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 05:42:50 +00:00
DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string Added deprecation warning to moduledev.rst and remove deprecated example from it Fixed up a few typos and uppercased some acronyms. add consistency to how EXAMPLES are formatted
This commit is contained in:
@@ -19,11 +19,15 @@ options:
|
||||
- The groups to add the hostname to, comma separated.
|
||||
required: false
|
||||
author: Seth Vidal
|
||||
examples:
|
||||
- description: add host to group 'just_created' with variable foo=42
|
||||
code: add_host hostname=${ip_from_ec2} groups=just_created foo=42
|
||||
- description: add a host with a non-standard port local to your machines
|
||||
code: add_host hostname='${new_ip}:${new_port}'
|
||||
- description: add a host alias that we reach through a tunnel
|
||||
code: add_host hostname=${new_ip} ansible_ssh_host=${inventory_hostname} ansible_ssh_port=${new_port}'
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# add host to group 'just_created' with variable foo=42
|
||||
- add_host: hostname=${ip_from_ec2} groups=just_created foo=42
|
||||
|
||||
# add a host with a non-standard port local to your machines
|
||||
- add_host: hostname='${new_ip}:${new_port}'
|
||||
|
||||
# add a host alias that we reach through a tunnel
|
||||
- add_host: hostname=${new_ip} ansible_ssh_host=${inventory_hostname} ansible_ssh_port=${new_port}'
|
||||
'''
|
||||
|
||||
@@ -13,11 +13,13 @@ options:
|
||||
- The variables whose values will be used as groups
|
||||
required: true
|
||||
author: Jeroen Hoekx
|
||||
examples:
|
||||
- description: Create groups based on the machine architecture
|
||||
code: group_by key=${ansible_machine}
|
||||
- description: Create groups like 'kvm-host'
|
||||
code: group_by key=${ansible_virtualization_type}-${ansible_virtualization_role}
|
||||
notes:
|
||||
- Spaces in group names are converted to dashes '-'.
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Create groups based on the machine architecture
|
||||
- group_by: key=${ansible_machine}
|
||||
# Create groups like 'kvm-host'
|
||||
- group_by: key=${ansible_virtualization_type}-${ansible_virtualization_role}
|
||||
'''
|
||||
|
||||
Reference in New Issue
Block a user