mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10:22 -07:00
Fix document references in modules (#49892)
* Docs: Fixes internal module reference syntax for seealso * Updates anchors and links * Updates seealso in the docs for module **win_chocolatey**.
This commit is contained in:
parent
651ea5da44
commit
653c3da500
6 changed files with 34 additions and 23 deletions
|
@ -94,4 +94,4 @@ And you use the ``eapi`` variable in your task(s):
|
|||
|
||||
Note that while Ansible 2.6 supports the use of ``connection: local`` with ``provider`` dictionaries, this usage will be deprecated in the future and eventually removed.
|
||||
|
||||
For more information, see :ref:`Become and Networks<become-network>`
|
||||
For more information, see :ref:`Become and Networks<become_network>`
|
||||
|
|
|
@ -157,7 +157,7 @@ Certain network platforms, such as eos and ios, have the concept of different pr
|
|||
ansible_become=yes
|
||||
ansible_become_method=enable
|
||||
|
||||
For more information, see the :ref:`using become with network modules<become-network>` guide.
|
||||
For more information, see the :ref:`using become with network modules<become_network>` guide.
|
||||
|
||||
|
||||
Jump hosts
|
||||
|
|
|
@ -319,7 +319,7 @@ The deprecation warnings reflect this schedule. The task above, run in Ansible 2
|
|||
[DEPRECATION WARNING]: Param 'host' is deprecated. See the module docs for more information. This feature will be removed in version 2.9.
|
||||
Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg.
|
||||
|
||||
We recommend using the new connection types ``network_cli`` and ``netconf`` (see below), using standard Ansible connection properties, and setting those properties in inventory by group. As you update your playbooks and inventory files, you can easily make the change to ``become`` for privilege escalation (on platforms that support it). For more information, see the :ref:`using become with network modules<become-network>` guide and the :ref:`platform documentation<platform_options>`.
|
||||
We recommend using the new connection types ``network_cli`` and ``netconf`` (see below), using standard Ansible connection properties, and setting those properties in inventory by group. As you update your playbooks and inventory files, you can easily make the change to ``become`` for privilege escalation (on platforms that support it). For more information, see the :ref:`using become with network modules<become_network>` guide and the :ref:`platform documentation<platform_options>`.
|
||||
|
||||
Adding persistent connection types ``network_cli`` and ``netconf``
|
||||
------------------------------------------------------------------
|
||||
|
|
|
@ -235,7 +235,7 @@ To force ``become`` to open a new systemd session that goes through
|
|||
For more information, see `this systemd issue
|
||||
<https://github.com/systemd/systemd/issues/825#issuecomment-127917622>`_.
|
||||
|
||||
.. _become-network:
|
||||
.. _become_network:
|
||||
|
||||
Become and Networks
|
||||
===================
|
||||
|
@ -324,7 +324,7 @@ Ansible still supports ``enable`` mode with ``connection: local`` for legacy pla
|
|||
|
||||
We recommend updating your playbooks to use ``become`` for network-device ``enable`` mode consistently. The use of ``authorize`` and of ``provider`` dictionaries will be deprecated in future. Check the :ref:`platform_options` and :ref:`network_modules` documentation for details.
|
||||
|
||||
.. _become-windows:
|
||||
.. _become_windows:
|
||||
|
||||
Become and Windows
|
||||
==================
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue