From cb9ef9a6b250768f068cd4fbe5f7ca2411037fed Mon Sep 17 00:00:00 2001 From: Nuno do Carmo Date: Mon, 25 Mar 2024 17:11:54 +0100 Subject: [PATCH] Fixed warning links with Sunil Since Docusaurus V3, the links need the `.md` as the page suffix and the anchors are case-sensitive. --- docs/how-to-guides/mirror-private-registry.md | 6 +++--- docs/how-to-guides/provisioning-scripts.md | 4 ++-- docs/how-to-guides/traefik-ingress-example.md | 2 +- docs/how-to-guides/using-testcontainers.md | 8 ++++---- docs/ui/port-forwarding.md | 2 +- docs/ui/preferences/virtual-machine/network.md | 2 +- docs/ui/snapshots.md | 2 +- .../version-1.13/how-to-guides/mirror-private-registry.md | 6 +++--- .../version-1.13/how-to-guides/traefik-ingress-example.md | 2 +- .../version-1.13/how-to-guides/using-testcontainers.md | 8 ++++---- .../ui/preferences/virtual-machine/network.md | 2 +- versioned_docs/version-1.13/ui/snapshots.md | 2 +- .../version-latest/how-to-guides/using-testcontainers.md | 8 ++++---- .../ui/preferences/virtual-machine/network.md | 2 +- versioned_docs/version-latest/ui/snapshots.md | 2 +- 15 files changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/how-to-guides/mirror-private-registry.md b/docs/how-to-guides/mirror-private-registry.md index 6c88686b29..5eb9b460da 100644 --- a/docs/how-to-guides/mirror-private-registry.md +++ b/docs/how-to-guides/mirror-private-registry.md @@ -13,7 +13,7 @@ Rancher Desktop can be configured to mirror private registries using either cont -Below is an example [provisioning script](../how-to-guides/provisioning-scripts#macos--linux) that can be used to mirror private registries. +Below is an example [provisioning script](../how-to-guides/provisioning-scripts.md#macOS--Linux) that can be used to mirror private registries. Check if you have the `override.yaml` file in the path below, otherwise you can create the file in the path with the suggested provisioning commands. @@ -45,7 +45,7 @@ rdctl shell -- cat /etc/rancher/k3s/registries.yaml -Below is an example [provisioning script](../how-to-guides/provisioning-scripts#macos--linux) that can be used to mirror private registries. +Below is an example [provisioning script](../how-to-guides/provisioning-scripts.md#macOS--Linux) that can be used to mirror private registries. Check if you have the `override.yaml` file in the path below, otherwise you can create the file in the path with the suggested provisioning commands. @@ -78,7 +78,7 @@ rdctl shell -- cat /etc/rancher/k3s/registries.yaml -Ensure that you have initialized the application with a first run in order to create the `\provisioning\` directory. Once created, [provisioning scripts](../how-to-guides/provisioning-scripts#windows) can be utilized to mirror private registries using a `.start` file. +Ensure that you have initialized the application with a first run in order to create the `\provisioning\` directory. Once created, [provisioning scripts](../how-to-guides/provisioning-scripts.md#Windows) can be utilized to mirror private registries using a `.start` file. The file path and example provisioning script are provided below. After you have created the file with the appropriate configuration, restart the Rancher Desktop application for the provisioning script to take effect. diff --git a/docs/how-to-guides/provisioning-scripts.md b/docs/how-to-guides/provisioning-scripts.md index 301048ecb6..1c43356602 100644 --- a/docs/how-to-guides/provisioning-scripts.md +++ b/docs/how-to-guides/provisioning-scripts.md @@ -10,7 +10,7 @@ import TabsConstants from '@site/core/TabsConstants'; Provisioning scripts can be used to override some of Rancher Desktop's internal processes. For example, scripts can be used to provide certain command line parameters to K3s, add additional mounts, increase ulimit value etc. This guide will explain how to set up your provisioning scripts for macOS, Linux, and Windows. -## macOS & Linux {#macos--linux} +## macOS & Linux On macOS and Linux, you can use lima override.yaml to write provisioning scripts. @@ -67,7 +67,7 @@ env: K3S_EXEC: --tls-san value ``` -## Windows {#windows} +## Windows **Caution:** You can only utilize these provisioning scripts for Rancher Desktop, version 1.1.0 or later, on Windows. diff --git a/docs/how-to-guides/traefik-ingress-example.md b/docs/how-to-guides/traefik-ingress-example.md index 604d0a60ab..8a2e6f0ba9 100644 --- a/docs/how-to-guides/traefik-ingress-example.md +++ b/docs/how-to-guides/traefik-ingress-example.md @@ -30,7 +30,7 @@ Rancher Desktop uses `K3s` under the hood, which in turn uses [Traefik](https:// 1. Create a `whoami` example with basic deployment, service, and Ingress objects defined: :::note - Some Linux distributions don't allow listening to privileged ports by default, please see the documentation on [Traefik port binding access](../getting-started/installation#traefik-port-binding-access) to authorize ports if necessary. + Some Linux distributions don't allow listening to privileged ports by default, please see the documentation on [Traefik port binding access](../getting-started/installation.md#traefik-port-binding-access) to authorize ports if necessary. ::: ```bash diff --git a/docs/how-to-guides/using-testcontainers.md b/docs/how-to-guides/using-testcontainers.md index 114901cd9c..2e83171e99 100644 --- a/docs/how-to-guides/using-testcontainers.md +++ b/docs/how-to-guides/using-testcontainers.md @@ -43,12 +43,12 @@ You can download a sample test repository in the `testcontainers-java-repro` loc Currently, workarounds are needed for using Testcontainers on macOS M1 machines. Below are methods for using Testcontainers on either runtime, depending on administrative access. -#### [QEMU](../ui/preferences/virtual-machine/emulation#qemu) +#### [QEMU](../ui/preferences/virtual-machine/emulation.md#qemu)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: @@ -58,12 +58,12 @@ export TESTCONTAINERS_HOST_OVERRIDE=$(rdctl shell ip a show rd0 | awk '/inet / {
-#### [VZ](../ui/preferences/virtual-machine/emulation#vz) +#### [VZ](../ui/preferences/virtual-machine/emulation.md#vz)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: diff --git a/docs/ui/port-forwarding.md b/docs/ui/port-forwarding.md index 3975a04042..339571c729 100644 --- a/docs/ui/port-forwarding.md +++ b/docs/ui/port-forwarding.md @@ -42,6 +42,6 @@ Rancher Desktop includes automated port forwarding for versions `1.9` and later. :::note -Please see [Traefik Port Binding Access](../getting-started/installation#traefik-port-binding-access) to configure ports at the operating system level. +Please see [Traefik Port Binding Access](../getting-started/installation.md#traefik-port-binding-access) to configure ports at the operating system level. ::: diff --git a/docs/ui/preferences/virtual-machine/network.md b/docs/ui/preferences/virtual-machine/network.md index b70e20610f..81dfe523c8 100644 --- a/docs/ui/preferences/virtual-machine/network.md +++ b/docs/ui/preferences/virtual-machine/network.md @@ -23,7 +23,7 @@ Network settings can be enabled or disabled from this view. Users have the initi When using the `vmnet` framework with Rancher Desktop, the macOS component [`mDNSResponder`](https://github.com/apple-oss-distributions/mDNSResponder#mdns-responder-daemon) will automatically start and make use of your machine's port `53`. The port is used to get a routable IP address for the virtual machine running the application's container engine. -If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. +If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general.md#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. :::caution warning Please note that with `Administrative Access` disabled, Rancher Desktop will no longer be able to create the Docker socket in the default location at `/var/run/docker.sock`. Instead, the application will create a [`docker context`](https://docs.docker.com/engine/context/working-with-contexts/) called `rancher-desktop` and switch to it automatically. Please be aware of this in the event you are running software that expects the default location and may not know about `docker contexts`. diff --git a/docs/ui/snapshots.md b/docs/ui/snapshots.md index c4bc480a91..c46031d7c1 100644 --- a/docs/ui/snapshots.md +++ b/docs/ui/snapshots.md @@ -60,4 +60,4 @@ The following actions can be taken on the tab: ### Command Line - `rdctl snapshot` -All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference) for more information. +All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference.md) for more information. diff --git a/versioned_docs/version-1.13/how-to-guides/mirror-private-registry.md b/versioned_docs/version-1.13/how-to-guides/mirror-private-registry.md index 6c88686b29..22b431b811 100644 --- a/versioned_docs/version-1.13/how-to-guides/mirror-private-registry.md +++ b/versioned_docs/version-1.13/how-to-guides/mirror-private-registry.md @@ -13,7 +13,7 @@ Rancher Desktop can be configured to mirror private registries using either cont -Below is an example [provisioning script](../how-to-guides/provisioning-scripts#macos--linux) that can be used to mirror private registries. +Below is an example [provisioning script](../how-to-guides/provisioning-scripts.md#macos--linux) that can be used to mirror private registries. Check if you have the `override.yaml` file in the path below, otherwise you can create the file in the path with the suggested provisioning commands. @@ -45,7 +45,7 @@ rdctl shell -- cat /etc/rancher/k3s/registries.yaml -Below is an example [provisioning script](../how-to-guides/provisioning-scripts#macos--linux) that can be used to mirror private registries. +Below is an example [provisioning script](../how-to-guides/provisioning-scripts.md#macos--linux) that can be used to mirror private registries. Check if you have the `override.yaml` file in the path below, otherwise you can create the file in the path with the suggested provisioning commands. @@ -78,7 +78,7 @@ rdctl shell -- cat /etc/rancher/k3s/registries.yaml -Ensure that you have initialized the application with a first run in order to create the `\provisioning\` directory. Once created, [provisioning scripts](../how-to-guides/provisioning-scripts#windows) can be utilized to mirror private registries using a `.start` file. +Ensure that you have initialized the application with a first run in order to create the `\provisioning\` directory. Once created, [provisioning scripts](../how-to-guides/provisioning-scripts.md#windows) can be utilized to mirror private registries using a `.start` file. The file path and example provisioning script are provided below. After you have created the file with the appropriate configuration, restart the Rancher Desktop application for the provisioning script to take effect. diff --git a/versioned_docs/version-1.13/how-to-guides/traefik-ingress-example.md b/versioned_docs/version-1.13/how-to-guides/traefik-ingress-example.md index 604d0a60ab..8a2e6f0ba9 100644 --- a/versioned_docs/version-1.13/how-to-guides/traefik-ingress-example.md +++ b/versioned_docs/version-1.13/how-to-guides/traefik-ingress-example.md @@ -30,7 +30,7 @@ Rancher Desktop uses `K3s` under the hood, which in turn uses [Traefik](https:// 1. Create a `whoami` example with basic deployment, service, and Ingress objects defined: :::note - Some Linux distributions don't allow listening to privileged ports by default, please see the documentation on [Traefik port binding access](../getting-started/installation#traefik-port-binding-access) to authorize ports if necessary. + Some Linux distributions don't allow listening to privileged ports by default, please see the documentation on [Traefik port binding access](../getting-started/installation.md#traefik-port-binding-access) to authorize ports if necessary. ::: ```bash diff --git a/versioned_docs/version-1.13/how-to-guides/using-testcontainers.md b/versioned_docs/version-1.13/how-to-guides/using-testcontainers.md index 114901cd9c..2e83171e99 100644 --- a/versioned_docs/version-1.13/how-to-guides/using-testcontainers.md +++ b/versioned_docs/version-1.13/how-to-guides/using-testcontainers.md @@ -43,12 +43,12 @@ You can download a sample test repository in the `testcontainers-java-repro` loc Currently, workarounds are needed for using Testcontainers on macOS M1 machines. Below are methods for using Testcontainers on either runtime, depending on administrative access. -#### [QEMU](../ui/preferences/virtual-machine/emulation#qemu) +#### [QEMU](../ui/preferences/virtual-machine/emulation.md#qemu)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: @@ -58,12 +58,12 @@ export TESTCONTAINERS_HOST_OVERRIDE=$(rdctl shell ip a show rd0 | awk '/inet / {
-#### [VZ](../ui/preferences/virtual-machine/emulation#vz) +#### [VZ](../ui/preferences/virtual-machine/emulation.md#vz)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: diff --git a/versioned_docs/version-1.13/ui/preferences/virtual-machine/network.md b/versioned_docs/version-1.13/ui/preferences/virtual-machine/network.md index b70e20610f..81dfe523c8 100644 --- a/versioned_docs/version-1.13/ui/preferences/virtual-machine/network.md +++ b/versioned_docs/version-1.13/ui/preferences/virtual-machine/network.md @@ -23,7 +23,7 @@ Network settings can be enabled or disabled from this view. Users have the initi When using the `vmnet` framework with Rancher Desktop, the macOS component [`mDNSResponder`](https://github.com/apple-oss-distributions/mDNSResponder#mdns-responder-daemon) will automatically start and make use of your machine's port `53`. The port is used to get a routable IP address for the virtual machine running the application's container engine. -If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. +If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general.md#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. :::caution warning Please note that with `Administrative Access` disabled, Rancher Desktop will no longer be able to create the Docker socket in the default location at `/var/run/docker.sock`. Instead, the application will create a [`docker context`](https://docs.docker.com/engine/context/working-with-contexts/) called `rancher-desktop` and switch to it automatically. Please be aware of this in the event you are running software that expects the default location and may not know about `docker contexts`. diff --git a/versioned_docs/version-1.13/ui/snapshots.md b/versioned_docs/version-1.13/ui/snapshots.md index c4bc480a91..c46031d7c1 100644 --- a/versioned_docs/version-1.13/ui/snapshots.md +++ b/versioned_docs/version-1.13/ui/snapshots.md @@ -60,4 +60,4 @@ The following actions can be taken on the tab: ### Command Line - `rdctl snapshot` -All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference) for more information. +All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference.md) for more information. diff --git a/versioned_docs/version-latest/how-to-guides/using-testcontainers.md b/versioned_docs/version-latest/how-to-guides/using-testcontainers.md index 114901cd9c..2e83171e99 100644 --- a/versioned_docs/version-latest/how-to-guides/using-testcontainers.md +++ b/versioned_docs/version-latest/how-to-guides/using-testcontainers.md @@ -43,12 +43,12 @@ You can download a sample test repository in the `testcontainers-java-repro` loc Currently, workarounds are needed for using Testcontainers on macOS M1 machines. Below are methods for using Testcontainers on either runtime, depending on administrative access. -#### [QEMU](../ui/preferences/virtual-machine/emulation#qemu) +#### [QEMU](../ui/preferences/virtual-machine/emulation.md#qemu)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: @@ -58,12 +58,12 @@ export TESTCONTAINERS_HOST_OVERRIDE=$(rdctl shell ip a show rd0 | awk '/inet / {
-#### [VZ](../ui/preferences/virtual-machine/emulation#vz) +#### [VZ](../ui/preferences/virtual-machine/emulation.md#vz)
Workaround Summary -This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general) dialog. This will ensure that routable IP's are allocated. +This runtime can be used with administrative access enabled which can be set via the [**Preferences > Application > General**](../ui/preferences/application/general.md) dialog. This will ensure that routable IP's are allocated. Next, export the virtual machine port explicitly using the command below: diff --git a/versioned_docs/version-latest/ui/preferences/virtual-machine/network.md b/versioned_docs/version-latest/ui/preferences/virtual-machine/network.md index b70e20610f..81dfe523c8 100644 --- a/versioned_docs/version-latest/ui/preferences/virtual-machine/network.md +++ b/versioned_docs/version-latest/ui/preferences/virtual-machine/network.md @@ -23,7 +23,7 @@ Network settings can be enabled or disabled from this view. Users have the initi When using the `vmnet` framework with Rancher Desktop, the macOS component [`mDNSResponder`](https://github.com/apple-oss-distributions/mDNSResponder#mdns-responder-daemon) will automatically start and make use of your machine's port `53`. The port is used to get a routable IP address for the virtual machine running the application's container engine. -If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. +If you need access to port `53`, or do not wish to make use of routable IP addresses, then you can achieve this by disabling [`Administrative Access`](../../../ui/preferences/application/general.md#administrative-access) from the *Preferences* dialog. Using `vmnet` requires starting a daemon via `sudo`, and with administrative access removed this will free port `53` from the `mDNSResponder` daemon. :::caution warning Please note that with `Administrative Access` disabled, Rancher Desktop will no longer be able to create the Docker socket in the default location at `/var/run/docker.sock`. Instead, the application will create a [`docker context`](https://docs.docker.com/engine/context/working-with-contexts/) called `rancher-desktop` and switch to it automatically. Please be aware of this in the event you are running software that expects the default location and may not know about `docker contexts`. diff --git a/versioned_docs/version-latest/ui/snapshots.md b/versioned_docs/version-latest/ui/snapshots.md index c4bc480a91..c46031d7c1 100644 --- a/versioned_docs/version-latest/ui/snapshots.md +++ b/versioned_docs/version-latest/ui/snapshots.md @@ -60,4 +60,4 @@ The following actions can be taken on the tab: ### Command Line - `rdctl snapshot` -All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference) for more information. +All commands available through the user interface are also available using the `rdctl snapshot` command. Please see the [reference page](../references/rdctl-command-reference.md) for more information.