From 41f21f4269a2ac13ae06c318cf9ff8b2942e71c7 Mon Sep 17 00:00:00 2001 From: Keirthana T S Date: Tue, 25 Jun 2024 21:03:27 +0530 Subject: [PATCH] Fix link checker - Escape link check for release notes - Escape link check for specific anchors - Fix links that were creating unnecessary dependencies --- custom_conf.py | 14 +++++++++++--- howto/anbox/tls-for-appliance.md | 2 +- howto/install/customise.md | 2 +- howto/install/deploy-juju.md | 2 +- 4 files changed, 14 insertions(+), 6 deletions(-) diff --git a/custom_conf.py b/custom_conf.py index 1928c494..f853f457 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -130,9 +130,17 @@ 'http://127.0.0.1:8000' ] -# Pages on which to ignore anchors -# (This list will be appended to linkcheck_anchors_ignore_for_url) -custom_linkcheck_anchors_ignore_for_url = [] +# This setting will check the links but not the anchors +# This list will be appended to linkcheck_anchors_ignore_for_url +custom_linkcheck_anchors_ignore_for_url = [ + r'https://matrix\.to/#/#anbox-cloud:ubuntu\.com', + r'https://canonical\.github\.io/anbox-cloud\.github\.com/latest/anbox-stream-gateway/#/session/handle-new-session', +] + +# Pages to ignore for link check +linkcheck_exclude_documents = [ + r'.*/release-notes/.*' +] ############################################################ ### Additions to default configuration diff --git a/howto/anbox/tls-for-appliance.md b/howto/anbox/tls-for-appliance.md index aba3af1a..f0da8055 100644 --- a/howto/anbox/tls-for-appliance.md +++ b/howto/anbox/tls-for-appliance.md @@ -163,7 +163,7 @@ DNS propagation usually takes a while. When it completes and the validation is s To use the Anbox Cloud Appliance through your domain name, AWS must route the HTTPS traffic for your domain to the Anbox Cloud Appliance. To ensure this, you must create a load balancer that listens for traffic and routes it to the appliance. -1. Go to the [Load balancers](https://us-east-1.console.aws.amazon.com/ec2/home#LoadBalancers:) page in the EC2 dashboard. +1. Go to the Load balancers page in the EC2 dashboard. 1. Click **Create load balancer**. 1. Choose `Application Load Balancer` as the load balancer type. 1. For the **Basic configuration**, keep the default options (scheme: internet-facing, IP address type: `IPv4`). diff --git a/howto/install/customise.md b/howto/install/customise.md index 1d0c99e1..d57d52d1 100644 --- a/howto/install/customise.md +++ b/howto/install/customise.md @@ -12,7 +12,7 @@ Saving a copy of the bundle file and editing that file means that your customisa ## Use overlay files -An [overlay bundle](https://juju.is/docs/sdk/bundle-reference#heading--overlay-bundles) is a fragment of valid YAML that is dynamically merged on top of a bundle file before deployment, similar to a patch file. The fragment can contain additional or alternative YAML that is intelligible to Juju. For example, you could use a bundle overlay to specify custom instance types for the machines you use (note that the specified constraints are just an example and not a recommendation): +An [overlay bundle](https://juju.is/docs/juju/bundle) is a fragment of valid YAML that is dynamically merged on top of a bundle file before deployment, similar to a patch file. The fragment can contain additional or alternative YAML that is intelligible to Juju. For example, you could use a bundle overlay to specify custom instance types for the machines you use (note that the specified constraints are just an example and not a recommendation): machines: '0': diff --git a/howto/install/deploy-juju.md b/howto/install/deploy-juju.md index c0d2a2a5..2f947413 100644 --- a/howto/install/deploy-juju.md +++ b/howto/install/deploy-juju.md @@ -134,7 +134,7 @@ Choose between the available {ref}`sec-juju-bundles`: ## Customise the hardware configuration -To customise the machine configuration Juju will use for the deployment, create another overlay file. Here you can, for example, specify AWS instance types, change the size or source of the root disk or other things. See the [complete list of constraints](https://juju.is/docs/olm/constraint#heading--complete-list-of-constraints) in the Juju documentation for details. +To customise the machine configuration Juju will use for the deployment, create another overlay file. Here you can, for example, specify AWS instance types, change the size or source of the root disk or other things. See the [complete list of constraints](https://juju.is/docs/juju/constraint#heading--list-of-constraints) in the Juju documentation for details. For the `anbox-cloud-core` bundle, such an `overlay.yaml` file looks like this: