Fix invalid fields in module DOCUMENATION (#22297)

* fix module doc fields

* More module docs corrections

* More module docs corrections

* More module docs corrections

* More module docs corrections

* correct aliases

* Review comments

* Must quote ':'

* More authors

* Use suboptions:

* restore type: bool

* type should be in the same place

* More tidyups

* authors

* Use suboptions

* revert

* remove duplicate author

* More issues post rebase
This commit is contained in:
John R Barker
2017-03-09 16:20:25 +00:00
committed by GitHub
parent 000ca2a2bc
commit e5b990a55a
138 changed files with 176 additions and 256 deletions

View File

@@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'],
DOCUMENTATION = '''
---
module: glance_image
author: "Benno Joy (@bennojoy)"
version_added: "1.2"
deprecated: Deprecated in 1.10. Use M(os_image) instead.
short_description: Add/Delete images from glance

View File

@@ -25,6 +25,7 @@ DOCUMENTATION = '''
---
module: nova_compute
version_added: "1.2"
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_server) instead.
short_description: Create/Delete VMs from OpenStack
description:

View File

@@ -24,6 +24,7 @@ DOCUMENTATION = '''
---
module: quantum_network
version_added: "1.4"
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_network) instead.
short_description: Creates/Removes networks from OpenStack
description:

View File

@@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['deprecated'],
DOCUMENTATION = '''
---
module: quantum_subnet
author: "Benno Joy (@bennojoy)"
deprecated: Deprecated in 2.0. Use M(os_subnet) instead.
version_added: "1.2"
short_description: Add/remove subnet from a network

View File

@@ -23,6 +23,7 @@ DOCUMENTATION = '''
---
module: os_floating_ip
version_added: "2.0"
author: "Davide Guerri <davide.guerri@hp.com>"
short_description: Add/Remove floating IP from an instance
extends_documentation_fragment: openstack
description:

View File

@@ -25,6 +25,7 @@ DOCUMENTATION = '''
---
module: os_keypair
short_description: Add/Delete a keypair from OpenStack
author: "Benno Joy (@bennojoy)"
extends_documentation_fragment: openstack
version_added: "2.0"
description:

View File

@@ -22,6 +22,9 @@ DOCUMENTATION = '''
---
module: os_keystone_domain
short_description: Manage OpenStack Identity Domains
author:
- Monty
- Haneef Ali
extends_documentation_fragment: openstack
version_added: "2.1"
description:

View File

@@ -52,13 +52,11 @@ options:
description:
- Unique name or ID of the external gateway network.
- required I(interfaces) or I(enable_snat) are provided.
type: string
required: false
default: None
project:
description:
- Unique name or ID of the project.
type: string
required: false
default: None
version_added: "2.2"

View File

@@ -24,6 +24,7 @@ DOCUMENTATION = '''
---
module: os_security_group_rule
short_description: Add/Delete rule from an existing security group
author: "Benno Joy (@bennojoy)"
extends_documentation_fragment: openstack
version_added: "2.0"
description:

View File

@@ -23,6 +23,7 @@ DOCUMENTATION = '''
---
module: os_server_facts
short_description: Retrieve facts about one or more compute instances
author: Monty
version_added: "2.0"
description:
- Retrieve facts about server instances from OpenStack.

View File

@@ -23,6 +23,7 @@ DOCUMENTATION = '''
module: os_user
short_description: Manage OpenStack Identity Users
extends_documentation_fragment: openstack
author: David Shrewsbury
version_added: "2.0"
description:
- Manage OpenStack Identity users. Users can be created,