clarify module functionality in docstrings: module creates domains and their @ A record only #35669 (#41872)

This commit is contained in:
jeromecc 2018-07-02 16:36:51 +02:00 committed by Brian Coca
parent 087fc0c20c
commit daaf711e44

View file

@ -16,9 +16,9 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
DOCUMENTATION = '''
---
module: digital_ocean_domain
short_description: Create/delete a DNS record in DigitalOcean
short_description: Create/delete a DNS domain in DigitalOcean
description:
- Create/delete a DNS record in DigitalOcean.
- Create/delete a DNS domain in DigitalOcean.
version_added: "1.6"
author: "Michael Gregson (@mgregson)"
options:
@ -36,7 +36,7 @@ options:
- String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key, or the name of a domain.
ip:
description:
- The IP address to point a domain at.
- An 'A' record for '@' ($ORIGIN) will be created with the value 'ip'. 'ip' is an IP version 4 address.
extends_documentation_fragment: digital_ocean.documentation
notes:
- Environment variables DO_OAUTH_TOKEN can be used for the oauth_token.
@ -49,14 +49,14 @@ requirements:
EXAMPLES = '''
# Create a domain record
# Create a domain
- digital_ocean_domain:
state: present
name: my.digitalocean.domain
ip: 127.0.0.1
# Create a droplet and a corresponding domain record
# Create a droplet and a corresponding domain
- digital_ocean:
state: present