fix last 7 docs errors on post-migration test runs (#68115)
* address toc-tree-glob-pattern-no-match errors * address Include-file-not-found error * address 2.10 porting guide errors, add warning to page * updates individual plugin type pages * Add ignores. Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> Co-authored-by: Matt Clay <matt@mystile.com>
This commit is contained in:
parent
4cecacb915
commit
69543b47c9
7 changed files with 31 additions and 42 deletions
|
@ -182,15 +182,9 @@ When creating a new module there are a few things to keep in mind:
|
|||
- Use the full cmdlet name instead of aliases, e.g. ``Remove-Item`` over ``rm``
|
||||
- Use named parameters with cmdlets, e.g. ``Remove-Item -Path C:\temp`` over ``Remove-Item C:\temp``
|
||||
|
||||
A very basic powershell module `win_environment <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/windows/win_environment.ps1>`_ is included below. It demonstrates how to implement check-mode and diff-support, and also shows a warning to the user when a specific condition is met.
|
||||
A very basic Powershell module `win_environment <https://github.com/ansible-collections/ansible.windows/blob/master/plugins/modules/win_environment.ps1>`_ incorporates best practices for Powershell modules. It demonstrates how to implement check-mode and diff-support, and also shows a warning to the user when a specific condition is met.
|
||||
|
||||
.. .. include:: ../../../../lib/ansible/modules/windows/win_environment.ps1
|
||||
.. :code: powershell
|
||||
|
||||
.. literalinclude:: ../../../../lib/ansible/modules/windows/win_environment.ps1
|
||||
:language: powershell
|
||||
|
||||
A slightly more advanced module is `win_uri <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/windows/win_uri.ps1>`_ which additionally shows how to use different parameter types (bool, str, int, list, dict, path) and a selection of choices for parameters, how to fail a module and how to handle exceptions.
|
||||
A slightly more advanced module is `win_uri <https://github.com/ansible-collections/ansible.windows/blob/master/plugins/modules/win_uri.ps1>`_ which additionally shows how to use different parameter types (bool, str, int, list, dict, path) and a selection of choices for parameters, how to fail a module and how to handle exceptions.
|
||||
|
||||
As part of the new ``AnsibleModule`` wrapper, the input parameters are defined and validated based on an argument
|
||||
spec. The following options can be set at the root level of the argument spec:
|
||||
|
|
|
@ -7,6 +7,10 @@ Cliconf Plugins
|
|||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. warning::
|
||||
|
||||
Links on this page may not point to the most recent versions of plugins. In preparation for the release of 2.10, many plugins and modules have migrated to Collections on `Ansible Galaxy <https://galaxy.ansible.com>`_. For the current development status of Collections and FAQ see `Ansible Collections Community Guide <https://github.com/ansible-collections/general/blob/master/README.rst>`_.
|
||||
|
||||
Cliconf plugins are abstractions over the CLI interface to network devices. They provide a standard interface
|
||||
for Ansible to execute tasks on those network devices.
|
||||
|
||||
|
@ -37,14 +41,7 @@ Plugins are self-documenting. Each plugin should document its configuration opti
|
|||
Plugin list
|
||||
-----------
|
||||
|
||||
You can use ``ansible-doc -t cliconf -l`` to see the list of available plugins.
|
||||
Use ``ansible-doc -t cliconf <plugin name>`` to see detailed documentation and examples.
|
||||
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
:glob:
|
||||
|
||||
cliconf/*
|
||||
These plugins have migrated to a collection. Updates on where to find and how to use them will be coming soon.
|
||||
|
||||
|
||||
.. seealso::
|
||||
|
|
|
@ -7,6 +7,10 @@ Httpapi Plugins
|
|||
:local:
|
||||
:depth: 2
|
||||
|
||||
.. warning::
|
||||
|
||||
Links on this page may not point to the most recent versions of plugins. In preparation for the release of 2.10, many plugins and modules have migrated to Collections on `Ansible Galaxy <https://galaxy.ansible.com>`_. For the current development status of Collections and FAQ see `Ansible Collections Community Guide <https://github.com/ansible-collections/general/blob/master/README.rst>`_.
|
||||
|
||||
Httpapi plugins tell Ansible how to interact with a remote device's HTTP-based API and execute tasks on the
|
||||
device.
|
||||
|
||||
|
@ -58,15 +62,7 @@ See the full working example at https://github.com/network-automation/httpapi.
|
|||
Plugin List
|
||||
-----------
|
||||
|
||||
You can use ``ansible-doc -t httpapi -l`` to see the list of available plugins.
|
||||
Use ``ansible-doc -t httpapi <plugin name>`` to see detailed documentation and examples.
|
||||
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
:glob:
|
||||
|
||||
httpapi/*
|
||||
|
||||
These plugins have migrated to a collection. Updates on where to find and how to use them will be coming soon.
|
||||
|
||||
.. seealso::
|
||||
|
||||
|
|
|
@ -7,8 +7,11 @@ Netconf Plugins
|
|||
:local:
|
||||
:depth: 2
|
||||
|
||||
Netconf plugins are abstractions over the Netconf interface to network devices. They provide a standard interface
|
||||
for Ansible to execute tasks on those network devices.
|
||||
.. warning::
|
||||
|
||||
Links on this page may not point to the most recent versions of plugins. In preparation for the release of 2.10, many plugins and modules have migrated to Collections on `Ansible Galaxy <https://galaxy.ansible.com>`_. For the current development status of Collections and FAQ see `Ansible Collections Community Guide <https://github.com/ansible-collections/general/blob/master/README.rst>`_.
|
||||
|
||||
Netconf plugins are abstractions over the Netconf interface to network devices. They provide a standard interface for Ansible to execute tasks on those network devices.
|
||||
|
||||
These plugins generally correspond one-to-one to network device platforms. The appropriate netconf plugin will
|
||||
thus be automatically loaded based on the ``ansible_network_os`` variable. If the platform supports standard
|
||||
|
@ -42,14 +45,7 @@ Plugins are self-documenting. Each plugin should document its configuration opti
|
|||
Plugin list
|
||||
-----------
|
||||
|
||||
You can use ``ansible-doc -t netconf -l`` to see the list of available plugins.
|
||||
Use ``ansible-doc -t netconf <plugin name>`` to see detailed documentation and examples.
|
||||
|
||||
|
||||
.. toctree:: :maxdepth: 1
|
||||
:glob:
|
||||
|
||||
netconf/*
|
||||
These plugins have migrated to a collection. Updates on where to find and how to use them will be coming soon.
|
||||
|
||||
|
||||
.. seealso::
|
||||
|
|
|
@ -17,12 +17,9 @@ This section covers the various types of plugins that are included with Ansible:
|
|||
become
|
||||
cache
|
||||
callback
|
||||
cliconf
|
||||
connection
|
||||
httpapi
|
||||
inventory
|
||||
lookup
|
||||
netconf
|
||||
shell
|
||||
strategy
|
||||
vars
|
||||
|
|
|
@ -5,6 +5,10 @@
|
|||
Ansible 2.10 Porting Guide
|
||||
**************************
|
||||
|
||||
.. warning::
|
||||
|
||||
Links on this page may not point to the most recent versions of modules. In preparation for the release of 2.10, many plugins and modules have migrated to Collections on `Ansible Galaxy <https://galaxy.ansible.com>`_. For the current development status of Collections and FAQ see `Ansible Collections Community Guide <https://github.com/ansible-collections/general/blob/master/README.rst>`_. We expect the 2.10 Porting Guide to change frequently up to the 2.10 release. Follow the conversations about collections on our various :ref:`communication` channels for the latest information on the status of the ``devel`` branch.
|
||||
|
||||
This section discusses the behavioral changes between Ansible 2.9 and Ansible 2.10.
|
||||
|
||||
It is intended to assist in updating your playbooks, plugins and other parts of your Ansible infrastructure so they will work with this version of Ansible.
|
||||
|
@ -39,6 +43,9 @@ Deprecated
|
|||
Modules
|
||||
=======
|
||||
|
||||
.. warning::
|
||||
|
||||
Links on this page may not point to the most recent versions of modules. We will update them when we can.
|
||||
|
||||
Modules removed
|
||||
---------------
|
||||
|
@ -53,9 +60,8 @@ Deprecation notices
|
|||
|
||||
The following modules will be removed in Ansible 2.14. Please update your playbooks accordingly.
|
||||
|
||||
* ldap_attr use :ref:`ldap_attrs <ldap_attrs_module>` instead.
|
||||
* vyos_static_route use :ref:`vyos_static_routes <vyos_static_routes_module>` instead.
|
||||
|
||||
* ldap_attr use ldap_attrs instead.
|
||||
* vyos_static_route use vyos_static_routes instead.
|
||||
|
||||
The following functionality will be removed in Ansible 2.14. Please update update your playbooks accordingly.
|
||||
|
||||
|
@ -95,7 +101,7 @@ The following functionality will change in Ansible 2.14. Please update update yo
|
|||
|
||||
The following modules will be removed in Ansible 2.14. Please update your playbooks accordingly.
|
||||
|
||||
* ``vmware_dns_config`` use :ref:`vmware_host_dns <vmware_host_dns_module>` instead.
|
||||
* ``vmware_dns_config`` use vmware_host_dns instead.
|
||||
|
||||
|
||||
Noteworthy module changes
|
||||
|
|
|
@ -7,6 +7,9 @@ docs/docsite/_themes/sphinx_rtd_theme/__init__.py metaclass-boilerplate
|
|||
docs/docsite/rst/conf.py future-import-boilerplate
|
||||
docs/docsite/rst/conf.py metaclass-boilerplate
|
||||
docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst no-smart-quotes
|
||||
docs/docsite/rst/plugins/cliconf.rst docs-build
|
||||
docs/docsite/rst/plugins/httpapi.rst docs-build
|
||||
docs/docsite/rst/plugins/netconf.rst docs-build
|
||||
examples/scripts/ConfigureRemotingForAnsible.ps1 pslint:PSCustomUseLiteralPath
|
||||
examples/scripts/upgrade_to_ps3.ps1 pslint:PSCustomUseLiteralPath
|
||||
examples/scripts/upgrade_to_ps3.ps1 pslint:PSUseApprovedVerbs
|
||||
|
|
Loading…
Reference in a new issue