Fix various typos in documentation (#75662)

* docs/docsite/rst/dev_guide/developing_modules_general_aci.rst: fix typos

* docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst: fix typos

* docs/docsite/rst/dev_guide/testing_units_modules.rst: fix typos

* docs/docsite/rst/network/dev_guide/developing_resource_modules_network.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.0.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.10.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_2.4.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_3.rst: fix typos

* docs/docsite/rst/porting_guides/porting_guide_4.rst: fix typos

* docs/docsite/rst/reference_appendices/glossary.rst: fix typos

* docs/docsite/rst/reference_appendices/release_and_maintenance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/collect_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_rest_scenarios/vm_tool_information.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_debugger.rst: fix typos

* docs/docsite/rst/user_guide/playbooks_filters.rst: fix typos

* docs/docsite/rst/user_guide/windows_performance.rst: fix typos

* docs/docsite/rst/scenario_guides/vmware_scenarios/vmware_inventory_vm_attributes.rst: fix typos
pull/75679/head
Erik Zettel 3 years ago committed by GitHub
parent 8d84f3c593
commit c2fa71c4e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -113,7 +113,7 @@ Once the AnsibleModule object has been initiated, the necessary parameter values
object_prop3 = module.params['object_prop3']
if object_prop3 is not None and object_prop3 not in range(x, y):
module.fail_json(msg='Valid object_prop3 values are between x and (y-1)')
child_object_id = module.params[' child_objec_id']
child_object_id = module.params['child_object_id']
child_object_prop = module.params['child_object_prop']
state = module.params['state']

@ -13,7 +13,7 @@ something like this:
try:
raise IOError('test')
except IOError:
e = get_excetion()
e = get_exception()
do_something(e)
except:
e = get_exception()

@ -270,7 +270,7 @@ Ansible special cases for unit testing
There are a number of special cases for unit testing the environment of an Ansible module.
The most common are documented below, and suggestions for others can be found by looking
at the source code of the existing unit tests or asking on the Ansible chat channel or mailing
lists. For more infomration on joining chat channels and subscribing to mailing lists, see :ref:`communication`.
lists. For more information on joining chat channels and subscribing to mailing lists, see :ref:`communication`.
Module argument processing
--------------------------

@ -484,7 +484,7 @@ We use Zuul as the CI to run the integration test.
* To view the report, click :guilabel:`Details` on the CI comment in the PR
* To view a failure report, click :guilabel:`ansible/check` and select the failed test.
* To view logs while the test is running, check for your PR number in the `Zull status board <https://dashboard.zuul.ansible.com/t/ansible/status>`_.
* To view logs while the test is running, check for your PR number in the `Zuul status board <https://dashboard.zuul.ansible.com/t/ansible/status>`_.
* To fix static test failure locally, run the :command:`tox -e black` **inside the root folder of collection**.
To view The Ansible run logs and debug test failures:

@ -62,7 +62,7 @@ uses key=value escaping which has not changed. The other option is to check for
old_message: >
Testing
some things
message: "{{ old_messsage[:-1] }}"
message: "{{ old_message[:-1] }}"
- debug:
msg: "{{ message }}"
# Output

@ -436,7 +436,7 @@ Deprecated Features
cisco.nxos
~~~~~~~~~~
- Deprecated `nxos_smu` in favour of `nxos_rpm` module.
- Deprecated `nxos_smu` in favor of `nxos_rpm` module.
- The `nxos_ospf_vrf` module is deprecated by `nxos_ospfv2` and `nxos_ospfv3` Resource Modules.
Porting Guide for v2.10.0
@ -834,7 +834,7 @@ community.vmware
community.windows
~~~~~~~~~~~~~~~~~
- win_disk_image - removed the deprecated return value ``mount_path`` in favour of ``mount_paths``.
- win_disk_image - removed the deprecated return value ``mount_path`` in favor of ``mount_paths``.
- win_psexec - removed the deprecated ``extra_opts`` option.
f5networks.f5_modules
@ -945,7 +945,7 @@ community.vmware
- The vmware_dns_config module has been deprecated and will be removed in a later release; use vmware_host_dns instead.
- vca - vca_fw, vca_nat, vca_app are deprecated since these modules rely on deprecated part of Pyvcloud library.
- vmware_dns_config - Deprecate in favour of new module vmware_host_dns.
- vmware_dns_config - Deprecate in favor of new module vmware_host_dns.
- vmware_guest - deprecate specifying CDROM configuration as a dict, instead use a list.
- vmware_tag_info - in a later release, the module will not return ``tag_facts`` since it does not return multiple tags with the same name and different category id. To maintain the existing behavior use ``tag_info`` which is a list of tag metadata.

@ -100,7 +100,7 @@ Noteworthy module changes
* The :ref:`win_get_url <win_get_url_module>` module has the dictionary ``win_get_url`` in its results deprecated, its content is now also available directly in the resulting output, like other modules. This dictionary will be removed in Ansible 2.8.
* The :ref:`win_unzip <win_unzip_module>` module no longer includes the dictionary ``win_unzip`` in its results; the contents are now included directly in the resulting output, like other modules.
* The :ref:`win_package <win_package_module>` module return values ``exit_code`` and ``restart_required`` have been deprecated in favour of ``rc`` and ``reboot_required`` respectively. The deprecated return values will be removed in Ansible 2.6.
* The :ref:`win_package <win_package_module>` module return values ``exit_code`` and ``restart_required`` have been deprecated in favor of ``rc`` and ``reboot_required`` respectively. The deprecated return values will be removed in Ansible 2.6.
Plugins

@ -591,7 +591,7 @@ cisco.nxos
- Deprecated `nxos_bgp` and `nxos_bgp_neighbor` modules in favor of `nxos_bgp_global` resource module.
- Deprecated `nxos_interface_ospf` in favor of `nxos_ospf_interfaces` Resource Module.
- Deprecated `nxos_smu` in favour of `nxos_rpm` module.
- Deprecated `nxos_smu` in favor of `nxos_rpm` module.
- The `nxos_ospf_vrf` module is deprecated by `nxos_ospfv2` and `nxos_ospfv3` Resource Modules.
community.aws

@ -266,9 +266,9 @@ Deprecated Features
ansible.windows
~~~~~~~~~~~~~~~
- win_updates - Deprecated the ``filtered_reason`` return value for each filtered up in favour of ``filtered_reasons``. This has been done to show all the reasons why an update was filtered and not just the first reason.
- win_updates - Deprecated the ``filtered_reason`` return value for each filtered up in favor of ``filtered_reasons``. This has been done to show all the reasons why an update was filtered and not just the first reason.
- win_updates - Deprecated the ``use_scheduled_task`` option as it is no longer used.
- win_updates - Deprecated the ``whitelist`` and ``blacklist`` options in favour of ``accept_list`` and ``reject_list`` respectively to conform to the new standards used in Ansible for these types of options.
- win_updates - Deprecated the ``whitelist`` and ``blacklist`` options in favor of ``accept_list`` and ``reject_list`` respectively to conform to the new standards used in Ansible for these types of options.
community.general
~~~~~~~~~~~~~~~~~
@ -698,8 +698,8 @@ ansible.netcommon
cisco.nxos
~~~~~~~~~~
- Deprecated nxos_bgp_af in favour of nxos_bgp_address_family resource module.
- Deprecated nxos_bgp_neighbor_af in favour of nxos_bgp_neighbor_address_family resource module.
- Deprecated nxos_bgp_af in favor of nxos_bgp_address_family resource module.
- Deprecated nxos_bgp_neighbor_af in favor of nxos_bgp_neighbor_address_family resource module.
cloudscale_ch.cloud
~~~~~~~~~~~~~~~~~~~

@ -68,7 +68,7 @@ when a term comes up on the mailing list.
The second part of a Fully Qualified Collection Name. The collection name divides the collection namespace and usually reflects the function of the collection content. For example, the ``cisco`` namespace might contain ``cisco.ios``, ``cisco.aci``, and ``cisco.nxos``, with content for managing the different network devices maintained by Cisco.
community.general (collection)
A special collection managed by the Ansible Community Team containing all the modules and plugins which shipped in Ansible 2.9 that do ont have their own dedicated Collection. See `community.general <https://galaxy.ansible.com/community/general>`_` on Galaxy.
A special collection managed by the Ansible Community Team containing all the modules and plugins which shipped in Ansible 2.9 that do not have their own dedicated Collection. See `community.general <https://galaxy.ansible.com/community/general>`_` on Galaxy.
community.network (collection)
Similar to ``community.general``, focusing on network content. `community.network <https://galaxy.ansible.com/community/network>`_` on Galaxy.

@ -207,7 +207,7 @@ We generate changelogs based on fragments. When creating new features for existi
To add changelog fragments to Collections in the Ansible community package, we recommend the `antsibull-changelog utility <https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst>`_.
To add changelog fragments for new features and bux fixes in ``ansible-core``, see the :ref:`changelog examples and instructions<changelogs_how_to>` in the Community Guide.
To add changelog fragments for new features and bug fixes in ``ansible-core``, see the :ref:`changelog examples and instructions<changelogs_how_to>` in the Community Guide.
Deprecation cycles
==================

@ -22,8 +22,7 @@ In this scenario we've got a vCenter with an ESXi host.
Our environment is pre-initialized with the following elements:
- A datacenter called ``my_dc``
- A cluster called ``my_cluser``
- A cluster called ``my_cluser``
- A cluster called ``my_cluster``
- An ESXi host called ``esxi1`` is in the cluster
- Two datastores on the ESXi: ``rw_datastore`` and ``ro_datastore``
- A dvswitch based guest network

@ -79,7 +79,7 @@ ______
Network routes
--------------
Use ``vcenter_vm_guest_networking_routes_info`` to explore the route table of your vitual machine.
Use ``vcenter_vm_guest_networking_routes_info`` to explore the route table of your virtual machine.
.. literalinclude:: task_outputs/Get_guest_network_routes_information.task.yaml

@ -196,7 +196,7 @@ poweredOnMonitorTypeChangeSupported (bool)
seSparseDiskSupported (bool)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Indicates whether the virtual machine supports the Flex-SE (space-efficent, sparse) format for virtual disks.
Indicates whether the virtual machine supports the Flex-SE (space-efficient, sparse) format for virtual disks.
nestedHVSupported (bool)
^^^^^^^^^^^^^^^^^^^^^^^^
@ -254,7 +254,7 @@ uuid (str)
instanceUuid (str, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID.
VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexadecimal string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID.
npivNodeWorldWideName (long, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -552,7 +552,7 @@ disk (vim.vm.FileLayoutEx.DiskLayout, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Layout of each virtual disk attached to the virtual machine.
For a virtual machine with snaphots, this property gives only those disks that are attached to it at the current point of running.
For a virtual machine with snapshots, this property gives only those disks that are attached to it at the current point of running.
snapshot (vim.vm.FileLayoutEx.SnapshotLayout, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1000,7 +1000,7 @@ appState (str, optional)
guestOperationsReady (bool, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Guest Operations availability. If true, the vitrual machine is ready to process guest operations.
Guest Operations availability. If true, the virtual machine is ready to process guest operations.
interactiveGuestOperationsReady (bool, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@ -1139,7 +1139,7 @@ The property is valid if snapshots have been created for the virtual machine.
currentSnapshot (vim.vm.Snapshot, optional)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Current snapshot of the virtual machineThis property is set by calling ``Snapshot.revert`` or ``VirtualMachine.createSnapshot``.
Current snapshot of the virtual machine. This property is set by calling ``Snapshot.revert`` or ``VirtualMachine.createSnapshot``.
This property will be empty when the working snapshot is at the root of the snapshot tree.
rootSnapshotList (vim.vm.SnapshotTree)

@ -101,7 +101,7 @@ To enable the task debugger with an environment variable, pass the variable when
ANSIBLE_ENABLE_TASK_DEBUGGER=True ansible-playbook -i hosts site.yml
When you enable the debugger globally, every failed task invokes the debugger, unless the role, play, block, or task explicity disables the debugger. If you need more granular control over what conditions trigger the debugger, use the ``debugger`` keyword.
When you enable the debugger globally, every failed task invokes the debugger, unless the role, play, block, or task explicitly disables the debugger. If you need more granular control over what conditions trigger the debugger, use the ``debugger`` keyword.
Enabling the debugger as a strategy
-----------------------------------

@ -1794,7 +1794,7 @@ Getting Kubernetes resource names
.. note::
These filters have migrated to the `kuberernetes.core <https://galaxy.ansible.com/kubernetes/core>`_ collection. Follow the installation instructions to install that collection.
These filters have migrated to the `kubernetes.core <https://galaxy.ansible.com/kubernetes/core>`_ collection. Follow the installation instructions to install that collection.
Use the "k8s_config_resource_name" filter to obtain the name of a Kubernetes ConfigMap or Secret,
including its hash::

@ -6,7 +6,7 @@ This document offers some performance optimizations you might like to apply to
your Windows hosts to speed them up specifically in the context of using Ansible
with them, and generally.
Optimise PowerShell performance to reduce Ansible task overhead
Optimize PowerShell performance to reduce Ansible task overhead
---------------------------------------------------------------
To speed up the startup of PowerShell by around 10x, run the following
PowerShell snippet in an Administrator session. Expect it to take tens of
@ -39,7 +39,7 @@ seconds.
}
Optimize-PowershellAssemblies
PowerShell is used by every Windows Ansible module. This optimisation reduces
PowerShell is used by every Windows Ansible module. This optimization reduces
the time PowerShell takes to start up, removing that overhead from every invocation.
This snippet uses `the native image generator, ngen <https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator#WhenToUse>`_

Loading…
Cancel
Save