From a6bb3ae29178b115927bd020d7c9374f21a65f01 Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Wed, 12 Feb 2020 11:47:00 -0500 Subject: [PATCH] fix some broken links (#67345) --- docs/docsite/rst/dev_guide/debugging.rst | 2 +- .../rst/scenario_guides/guide_kubernetes.rst | 2 +- .../cloud/google/gcp_compute_firewall_info.py | 2 +- .../google/gcp_compute_forwarding_rule_info.py | 2 +- .../gcp_compute_global_forwarding_rule_info.py | 2 +- .../cloud/google/gcp_compute_route_info.py | 15 ++++++++------- lib/ansible/modules/crypto/openssl_certificate.py | 2 +- 7 files changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/docsite/rst/dev_guide/debugging.rst b/docs/docsite/rst/dev_guide/debugging.rst index 1d0064b2b9c..1dd87f4f361 100644 --- a/docs/docsite/rst/dev_guide/debugging.rst +++ b/docs/docsite/rst/dev_guide/debugging.rst @@ -118,7 +118,7 @@ When you look into the debug_dir you'll see a directory structure like this:: files for any :mod:`ansible.module_utils` imports in the module but not any files from any other module. So if your module uses :mod:`ansible.module_utils.url` Ansible will include it for you, but if - your module includes `requests `_ then you'll have to make sure that + your module includes `requests `_ then you'll have to make sure that the python `requests library `_ is installed on the system before running the module. You can modify files in this directory if you suspect that the module is having a problem in some of this boilerplate code rather than in diff --git a/docs/docsite/rst/scenario_guides/guide_kubernetes.rst b/docs/docsite/rst/scenario_guides/guide_kubernetes.rst index 9f24abcbf4f..81b0598ea41 100644 --- a/docs/docsite/rst/scenario_guides/guide_kubernetes.rst +++ b/docs/docsite/rst/scenario_guides/guide_kubernetes.rst @@ -36,7 +36,7 @@ Next, include it in a playbook, as follows: Because the role is referenced, ``hello-world`` is able to access the modules, and use them to deploy an application. -The modules are found in the ``library`` folder of the role. Each includes full documentation for parameters and the returned data structure. However, not all modules include examples, only those where `testing data `_ has been created. +The modules are found in the ``library`` folder of the role. Each includes full documentation for parameters and the returned data structure. However, not all modules include examples, only those where `testing data `_ has been created. Authenticating with the API --------------------------- diff --git a/lib/ansible/modules/cloud/google/gcp_compute_firewall_info.py b/lib/ansible/modules/cloud/google/gcp_compute_firewall_info.py index cdd088f7441..a12ad9b4854 100644 --- a/lib/ansible/modules/cloud/google/gcp_compute_firewall_info.py +++ b/lib/ansible/modules/cloud/google/gcp_compute_firewall_info.py @@ -226,7 +226,7 @@ resources: - 'URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this property, you can specify the network as a full - or partial URL. For example, the following are all valid URLs: U(https://www.googleapis.com/compute/v1/projects/myproject/global/) + or partial URL. For example, the following are all valid URLs: https://www.googleapis.com/compute/v1/projects/myproject/global/ networks/my-network projects/myproject/global/networks/my-network global/networks/default .' returned: success diff --git a/lib/ansible/modules/cloud/google/gcp_compute_forwarding_rule_info.py b/lib/ansible/modules/cloud/google/gcp_compute_forwarding_rule_info.py index ab7601ce2fb..e67dccf7ccd 100644 --- a/lib/ansible/modules/cloud/google/gcp_compute_forwarding_rule_info.py +++ b/lib/ansible/modules/cloud/google/gcp_compute_forwarding_rule_info.py @@ -153,7 +153,7 @@ resources: for this forwarding rule. - 'An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: * 100.1.2.3 - * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) + * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address .' returned: success diff --git a/lib/ansible/modules/cloud/google/gcp_compute_global_forwarding_rule_info.py b/lib/ansible/modules/cloud/google/gcp_compute_global_forwarding_rule_info.py index e205f92d66a..9e92b18e111 100644 --- a/lib/ansible/modules/cloud/google/gcp_compute_global_forwarding_rule_info.py +++ b/lib/ansible/modules/cloud/google/gcp_compute_global_forwarding_rule_info.py @@ -146,7 +146,7 @@ resources: for this forwarding rule. - 'An address can be specified either by a literal IP address or a URL reference to an existing Address resource. The following examples are all valid: * 100.1.2.3 - * U(https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address) + * https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address * projects/project/regions/region/addresses/address * regions/region/addresses/address * global/addresses/address * address .' returned: success diff --git a/lib/ansible/modules/cloud/google/gcp_compute_route_info.py b/lib/ansible/modules/cloud/google/gcp_compute_route_info.py index e46fd875e37..76dbcf7d03a 100644 --- a/lib/ansible/modules/cloud/google/gcp_compute_route_info.py +++ b/lib/ansible/modules/cloud/google/gcp_compute_route_info.py @@ -156,18 +156,19 @@ resources: nextHopGateway: description: - URL to a gateway that should handle matching packets. - - 'Currently, you can only specify the internet gateway, using a full or partial - valid URL: * U(https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway) - * projects/project/global/gateways/default-internet-gateway * global/gateways/default-internet-gateway - .' + - 'Currently, you can only specify the internet gateway, using a full or partial valid URL:' + - ' * https://www.googleapis.com/compute/v1/projects/project/global/gateways/default-internet-gateway' + - ' * projects/project/global/gateways/default-internet-gateway' + - ' * global/gateways/default-internet-gateway' returned: success type: str nextHopInstance: description: - URL to an instance that should handle matching packets. - - 'You can specify this as a full or partial URL. For example: * U(https://www.googleapis.com/compute/v1/projects/project/zones/zone/) - instances/instance * projects/project/zones/zone/instances/instance * zones/zone/instances/instance - .' + - 'You can specify this as a full or partial URL. For example:' + - ' * https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance' + - ' * projects/project/zones/zone/instances/instance' + - ' * zones/zone/instances/instance' returned: success type: dict nextHopIp: diff --git a/lib/ansible/modules/crypto/openssl_certificate.py b/lib/ansible/modules/crypto/openssl_certificate.py index 8c31bea988c..88dd09e9a91 100644 --- a/lib/ansible/modules/crypto/openssl_certificate.py +++ b/lib/ansible/modules/crypto/openssl_certificate.py @@ -67,7 +67,7 @@ options: Please see the examples on how to emulate it with M(openssl_certificate_info), M(openssl_csr_info), M(openssl_privatekey_info) and M(assert). - "The C(entrust) provider was added for Ansible 2.9 and requires credentials for the - L(https://www.entrustdatacard.com/products/categories/ssl-certificates,Entrust Certificate Services) (ECS) API." + L(Entrust Certificate Services,https://www.entrustdatacard.com/products/categories/ssl-certificates) (ECS) API." - Required if I(state) is C(present). type: str choices: [ acme, assertonly, entrust, ownca, selfsigned ]