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:
@@ -58,21 +58,29 @@ options:
|
||||
description:
|
||||
- Additional arguments provided on the command line
|
||||
aliases: [ 'args' ]
|
||||
examples:
|
||||
- description: Example action to start service httpd, if not running
|
||||
code: "service: name=httpd state=started"
|
||||
- description: Example action to stop service httpd, if running
|
||||
code: "service: name=httpd state=stopped"
|
||||
- description: Example action to restart service httpd, in all cases
|
||||
code: "service: name=httpd state=restarted"
|
||||
- description: Example action to reload service httpd, in all cases
|
||||
code: "service: name=httpd state=reloaded"
|
||||
- description: Example action to enable service httpd, and not touch the running state
|
||||
code: "service: name=httpd enabled=yes"
|
||||
- description: Example action to start service foo, based on running process /usr/bin/foo
|
||||
code: "service: name=foo pattern=/usr/bin/foo state=started"
|
||||
- description: Example action to restart network service for interface eth0
|
||||
code: "service: name=network state=restarted args=eth0"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Example action to start service httpd, if not running
|
||||
- service: name=httpd state=started
|
||||
|
||||
# Example action to stop service httpd, if running
|
||||
- service: name=httpd state=stopped
|
||||
|
||||
# Example action to restart service httpd, in all cases
|
||||
- service: name=httpd state=restarted
|
||||
|
||||
# Example action to reload service httpd, in all cases
|
||||
- service: name=httpd state=reloaded
|
||||
|
||||
# Example action to enable service httpd, and not touch the running state
|
||||
- service: name=httpd enabled=yes
|
||||
|
||||
# Example action to start service foo, based on running process /usr/bin/foo
|
||||
- service: name=foo pattern=/usr/bin/foo state=started
|
||||
|
||||
# Example action to restart network service for interface eth0
|
||||
- service: name=network state=restarted args=eth0
|
||||
'''
|
||||
|
||||
import platform
|
||||
|
||||
Reference in New Issue
Block a user