mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51:24 -07:00
[PR #9395/3048d530 backport][stable-9] g*.py: normalize docs (#9414)
g*.py: normalize docs (#9395)
* g*.py: normalize docs
* Update plugins/modules/gandi_livedns.py
Co-authored-by: Felix Fontein <felix@fontein.de>
---------
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 3048d5305d
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
87d63c5bed
commit
a66b9fc5c9
36 changed files with 633 additions and 683 deletions
|
@ -9,13 +9,11 @@ from __future__ import absolute_import, division, print_function
|
|||
__metaclass__ = type
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: grove
|
||||
short_description: Sends a notification to a grove.io channel
|
||||
description:
|
||||
- The C(grove) module sends a message for a service to a Grove.io
|
||||
channel.
|
||||
- The C(grove) module sends a message for a service to a Grove.io channel.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
|
@ -32,7 +30,7 @@ options:
|
|||
service:
|
||||
type: str
|
||||
description:
|
||||
- Name of the service (displayed as the "user" in the message)
|
||||
- Name of the service (displayed as the "user" in the message).
|
||||
required: false
|
||||
default: ansible
|
||||
message_content:
|
||||
|
@ -44,29 +42,29 @@ options:
|
|||
url:
|
||||
type: str
|
||||
description:
|
||||
- Service URL for the web client
|
||||
- Service URL for the web client.
|
||||
required: false
|
||||
icon_url:
|
||||
type: str
|
||||
description:
|
||||
- Icon for the service
|
||||
- Icon for the service.
|
||||
required: false
|
||||
validate_certs:
|
||||
description:
|
||||
- If V(false), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
|
||||
self-signed certificates.
|
||||
default: true
|
||||
type: bool
|
||||
author: "Jonas Pfenniger (@zimbatm)"
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Sends a notification to a grove.io channel
|
||||
community.general.grove:
|
||||
channel_token: 6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
|
||||
service: my-app
|
||||
message: 'deployed {{ target }}'
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.six.moves.urllib.parse import urlencode
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue