mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
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:
parent
000ca2a2bc
commit
e5b990a55a
138 changed files with 176 additions and 256 deletions
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_credential
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower credential.
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_group
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower group.
|
||||
description:
|
||||
|
|
|
@ -24,6 +24,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: tower_host
|
||||
version_added: "2.3"
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: create, update, or destroy Ansible Tower host.
|
||||
description:
|
||||
- Create, update, or destroy Ansible Tower hosts. See
|
||||
|
|
|
@ -24,6 +24,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: tower_inventory
|
||||
version_added: "2.3"
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: create, update, or destroy Ansible Tower inventory.
|
||||
description:
|
||||
- Create, update, or destroy Ansible Tower inventories. See
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_job_cancel
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: Cancel an Ansible Tower Job.
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_job_launch
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: Launch an Ansible Job.
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_job_list
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: List Ansible Tower jobs.
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_job_template
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower job_template.
|
||||
description:
|
||||
|
|
|
@ -24,6 +24,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: tower_job_wait
|
||||
version_added: "2.3"
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: Wait for Ansible Tower job to finish.
|
||||
description:
|
||||
- Wait for Ansible Tower job to finish and report success or failure. See
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_label
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower label.
|
||||
description:
|
||||
|
|
|
@ -24,6 +24,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: tower_organization
|
||||
version_added: "2.3"
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: create, update, or destroy Ansible Tower organizations
|
||||
description:
|
||||
- Create, update, or destroy Ansible Tower organizations. See
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_project
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower projects
|
||||
description:
|
||||
|
|
|
@ -24,6 +24,7 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: tower_role
|
||||
version_added: "2.3"
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
short_description: create, update, or destroy Ansible Tower role.
|
||||
description:
|
||||
- Create, update, or destroy Ansible Tower roles. See
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_team
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower team.
|
||||
description:
|
||||
|
|
|
@ -23,6 +23,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: tower_user
|
||||
author: "Wayne Witzel III (@wwitzel3)"
|
||||
version_added: "2.3"
|
||||
short_description: create, update, or destroy Ansible Tower user.
|
||||
description:
|
||||
|
|
|
@ -25,6 +25,7 @@ ANSIBLE_METADATA = {'status': ['preview'],
|
|||
DOCUMENTATION = '''
|
||||
---
|
||||
module: apache2_mod_proxy
|
||||
author: Olivier Boukili (@oboukili)"
|
||||
version_added: "2.2"
|
||||
short_description: Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool
|
||||
description:
|
||||
|
|
|
@ -72,7 +72,7 @@ notes:
|
|||
- "This module depends on the I(passlib) Python library, which needs to be installed on all target systems."
|
||||
- "On Debian, Ubuntu, or Fedora: install I(python-passlib)."
|
||||
- "On RHEL or CentOS: Enable EPEL, then install I(python-passlib)."
|
||||
requires: [ passlib>=1.6 ]
|
||||
requirements: [ passlib>=1.6 ]
|
||||
author: "Ansible Core Team"
|
||||
"""
|
||||
|
||||
|
|
|
@ -62,7 +62,7 @@ options:
|
|||
password:
|
||||
description:
|
||||
- The password to connect to the jenkins server with.
|
||||
require: false
|
||||
required: false
|
||||
default: null
|
||||
args:
|
||||
description:
|
||||
|
|
|
@ -88,7 +88,7 @@ options:
|
|||
will lead to an individual challenge that must be fulfilled for the
|
||||
CSR to be signed."
|
||||
required: true
|
||||
alias: ['src']
|
||||
aliases: ['src']
|
||||
data:
|
||||
description:
|
||||
- "The data to validate ongoing challenges."
|
||||
|
@ -99,7 +99,7 @@ options:
|
|||
dest:
|
||||
description: The destination file for the certificate.
|
||||
required: true
|
||||
alias: ['cert']
|
||||
aliases: ['cert']
|
||||
remaining_days:
|
||||
description:
|
||||
- "The number of days the certificate must have left being valid.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue