mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-31 09:01:23 -07:00
Fix various RST warnings (#34084)
* Fix various RST warnings * shorter lines
This commit is contained in:
parent
20174f1c47
commit
c50da48049
5 changed files with 20 additions and 23 deletions
|
@ -52,7 +52,7 @@ for aclass in class_list:
|
||||||
|
|
||||||
# loop is really with_ for users
|
# loop is really with_ for users
|
||||||
if name == 'Task':
|
if name == 'Task':
|
||||||
oblist[name]['with_<lookup_plugin>'] = 'DEPRECATED: use ``loop`` instead, with_ used to be how loops were defined, '
|
oblist[name]['with_<lookup_plugin>'] = 'DEPRECATED: use ``loop`` instead, ``with_`` used to be how loops were defined, '
|
||||||
'it can use any available lookup plugin to generate the item list'
|
'it can use any available lookup plugin to generate the item list'
|
||||||
|
|
||||||
# local_action is implicit with action
|
# local_action is implicit with action
|
||||||
|
|
|
@ -26,7 +26,7 @@ Although it's tempting to get straight into coding, there are a few things to be
|
||||||
* Shared code can be placed into ``lib/ansible/module_utils/``
|
* Shared code can be placed into ``lib/ansible/module_utils/``
|
||||||
* Shared documentation (for example describing common arguments) can be placed in ``lib/ansible/utils/module_docs_fragments/``.
|
* Shared documentation (for example describing common arguments) can be placed in ``lib/ansible/utils/module_docs_fragments/``.
|
||||||
* With great power comes great responsibility: Ansible module maintainers have a duty to help keep modules up to date. As with all successful community projects, module maintainers should keep a watchful eye for reported issues and contributions.
|
* With great power comes great responsibility: Ansible module maintainers have a duty to help keep modules up to date. As with all successful community projects, module maintainers should keep a watchful eye for reported issues and contributions.
|
||||||
* Although not required, unit and/or integration tests are strongly recommended. Unit tests are especially valuable when external resources (such as cloud or network devices) are required. For more information see :doc:`dev_guide/testing` and the `Testing Working Group <https://github.com/ansible/community/blob/master/meetings/README.md>`_.
|
* Although not required, unit and/or integration tests are strongly recommended. Unit tests are especially valuable when external resources (such as cloud or network devices) are required. For more information see :doc:`testing` and the `Testing Working Group <https://github.com/ansible/community/blob/master/meetings/README.md>`_.
|
||||||
* Starting with Ansible 2.4 all :doc:`../list_of_network_modules` MUST have unit tests.
|
* Starting with Ansible 2.4 all :doc:`../list_of_network_modules` MUST have unit tests.
|
||||||
|
|
||||||
|
|
||||||
|
|
27
docs/templates/config.rst.j2
vendored
27
docs/templates/config.rst.j2
vendored
|
@ -6,9 +6,9 @@
|
||||||
{{name}}
|
{{name}}
|
||||||
{{ '=' * name_len }}
|
{{ '=' * name_len }}
|
||||||
|
|
||||||
Ansible supports a few ways of providing configuration variables, mainly through environment variables, command line switches and an ini file `ansible.cfg`.
|
Ansible supports a few ways of providing configuration variables, mainly through environment variables, command line switches and an ini file ``ansible.cfg``.
|
||||||
|
|
||||||
Starting at Ansible 2.4 the `ansible-config` utility allows users to see all the configuration settings available, their defaults, how to set them and
|
Starting at Ansible 2.4 the ``ansible-config`` utility allows users to see all the configuration settings available, their defaults, how to set them and
|
||||||
where their current value comes from. See :doc:ansible-config for more information.
|
where their current value comes from. See :doc:ansible-config for more information.
|
||||||
|
|
||||||
|
|
||||||
|
@ -17,20 +17,21 @@ The configuration file
|
||||||
|
|
||||||
Changes can be made and used in a configuration file which will be searched for in the following order:
|
Changes can be made and used in a configuration file which will be searched for in the following order:
|
||||||
|
|
||||||
* ANSIBLE_CONFIG (environment variable if set)
|
* ``ANSIBLE_CONFIG`` (environment variable if set)
|
||||||
* ansible.cfg (in the current directory)
|
* ``ansible.cfg`` (in the current directory)
|
||||||
* ~/.ansible.cfg (in the home directory)
|
* ``~/.ansible.cfg`` (in the home directory)
|
||||||
* /etc/ansible/ansible.cfg
|
* ``/etc/ansible/ansible.cfg``
|
||||||
|
|
||||||
Ansible will process the above list and use the first file found, all others are ignored.
|
Ansible will process the above list and use the first file found, all others are ignored.
|
||||||
|
|
||||||
.. note:: Comments
|
.. note::
|
||||||
The configuration file is one variant of an INI format.
|
|
||||||
Both the hash sign ("#") and semicolon (";") are allowed as
|
The configuration file is one variant of an INI format.
|
||||||
comment markers when the comment starts the line.
|
Both the hash sign (``#``) and semicolon (``;``) are allowed as
|
||||||
However, if the comment is inline with regular values,
|
comment markers when the comment starts the line.
|
||||||
only the semicolon is allowed to introduce the comment.
|
However, if the comment is inline with regular values,
|
||||||
For instance::
|
only the semicolon is allowed to introduce the comment.
|
||||||
|
For instance::
|
||||||
|
|
||||||
# some basic default values...
|
# some basic default values...
|
||||||
inventory = /etc/ansible/hosts ; This points to the file that lists your hosts
|
inventory = /etc/ansible/hosts ; This points to the file that lists your hosts
|
||||||
|
|
|
@ -24,14 +24,11 @@ extends_documentation_fragment:
|
||||||
- aws
|
- aws
|
||||||
- ec2
|
- ec2
|
||||||
description:
|
description:
|
||||||
- Create and manage AWS Datapipelines. Creation is not idempotent in AWS,
|
- Create and manage AWS Datapipelines. Creation is not idempotent in AWS, so the I(uniqueId) is created by hashing the options (minus objects)
|
||||||
so the uniqueId is created by hashing the options (minus objects) given to the datapipeline.
|
given to the datapipeline.
|
||||||
|
- The pipeline definition must be in the format given here
|
||||||
The pipeline definition must be in the format given here
|
|
||||||
U(http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html#API_PutPipelineDefinition_RequestSyntax).
|
U(http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html#API_PutPipelineDefinition_RequestSyntax).
|
||||||
|
- Also operations will wait for a configurable amount of time to ensure the pipeline is in the requested state.
|
||||||
Also operations will wait for a configurable amount
|
|
||||||
of time to ensure the pipeline is in the requested state.
|
|
||||||
options:
|
options:
|
||||||
name:
|
name:
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -26,7 +26,6 @@ DOCUMENTATION = """
|
||||||
ini:
|
ini:
|
||||||
- section: lookup_redis
|
- section: lookup_redis
|
||||||
key: host
|
key: host
|
||||||
port:
|
|
||||||
port:
|
port:
|
||||||
description: port on which Redis is listening on
|
description: port on which Redis is listening on
|
||||||
default: 6379A
|
default: 6379A
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue