Network modules to link to network guide (#37033)

* Network modules to link to network guide

* Make it clear what's deprecated
* enable -> become
* Detail when provider is still needed (eAPI/NX-API)
* Link to specific sections
* rx_rate & tx_rate to link to conditional docs
This commit is contained in:
John R Barker 2018-03-06 12:01:07 +00:00 committed by GitHub
parent 5f3feac7fa
commit ebc71bcb16
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 97 additions and 8 deletions

View file

@ -24,6 +24,10 @@ class ModuleDocFragment(object):
options:
provider:
description:
- B(Deprecated)
- "Starting with Ansible 2.5 we recommend using C(connection: network_cli)."
- For more information please see the L(Network Guide, ../network/getting_started/network_differences.html#multiple-communication-protocols).
- HORIZONTALLINE
- A dict object containing connection details.
default: null
suboptions:
@ -35,8 +39,7 @@ options:
required: true
port:
description:
- Specifies the port to use when building the connection to the remote.
device.
- Specifies the port to use when building the connection to the remote device.
default: 22
username:
description:
@ -68,5 +71,6 @@ requirements:
- "ncclient >= 0.5.3 when using netconf"
- "lxml >= 4.1.1 when using netconf"
notes:
- For more information on using Ansible to manage Cisco devices see U(https://www.ansible.com/ansible-cisco).
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
"""