Replace hardcoded URLs with ref shortcodes (#1771)

Author: viren-nadkarni

README.md

@@ -88,6 +88,14 @@ Please follow these best practices when writing documentation in this repository
   If needed, you can also [highlight a specific line](https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences).
 - **Internal links:** Use the [`ref` or `relref` shortcode](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) when creating non-external links (but still use the markdown native image linking, ref doesn't work there).
   You can either use `ref` or `relref`, the point is to have compile time internal-link checks (which works for both).
+
+  ```text
+  # Do this
+  Configuration options are [here]({{< ref "/references/configuration" >}})
+
+  # Don't do this
+  Configuration options are [here](https://docs.localstack.cloud/references/configuration/)
+  ```
 - **Code snippets:** For snippets, make sure you indicate the programming/markup language so that proper syntax highlighting is used.
   Use `bash` only for Bash scripts, and use `text` for shell outputs or command examples.
   The full list of the supported languages [here](https://gohugo.io/content-management/syntax-highlighting/).

content/en/getting-started/auth-token/index.md

@@ -97,7 +97,7 @@ You have the option to run your LocalStack container in the background by append
 The `localstack` CLI automatically detects the Auth Token and appropriately conveys it to the LocalStack container.
 
 {{< callout "note" >}}
-If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image), which includes Pro services and several advanced features.
+If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image]({{< ref "/references/docker-images/#localstack-pro-image" >}}), which includes Pro services and several advanced features.
 {{< /callout >}}
 
 ### Docker
@@ -113,7 +113,7 @@ $ docker run \
   localstack/localstack-pro
 {{< / command >}}
 
-For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide.
+For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "/getting-started/installation/#docker" >}}) guide.
 
 ### Docker Compose
 
@@ -134,7 +134,7 @@ Developer Auth Tokens cannot be used in CI.
 CI Auth Tokens are available on the [Auth Tokens page](https://app.localstack.cloud/workspace/auth-tokens) and are configured similarly to Developer Auth Tokens.
 
 To set the CI Auth Token, add the Auth Token value in the `LOCALSTACK_AUTH_TOKEN` environment variable of your CI provider, and refer to it when starting LocalStack in your CI workflow.
-You can find detailed examples in our [LocalStack in CI documentation](https://docs.localstack.cloud/user-guide/ci/).
+You can find detailed examples in our [LocalStack in CI documentation]({{< ref "/user-guide/ci/" >}}).
 
 ## Rotating the Auth Token
 
@@ -150,7 +150,7 @@ To rotate your Auth Token, go to the [Auth Token page](https://app.localstack.cl
 ## Licensing configuration & activation checkup
 
 To avoid logging any licensing-related error messages, set `LOG_LICENSE_ISSUES=0` in your environment.
-Refer to our [configuration guide](https://docs.localstack.cloud/references/configuration/#localstack-pro) for more information.
+Refer to our [configuration guide]({{< ref "/references/configuration/#localstack-pro" >}}) for more information.
 
 The simplest method to verify if LocalStack is active is by querying the health endpoint for a list of running services:
 

content/en/getting-started/faq.md

@@ -18,7 +18,7 @@ To resolve the issue follow the steps:
   This can be done by deleting the cached certificate file.
   For example, on Linux systems, you can locate and remove the file at  `~/.cache/localstack/volume/cache/server.test.pem`.
   The exact path may differ depending on your operating system and how you’ve started LocalStack.
-  Please refer to our [documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume) for specific instructions.
+  Please refer to our [documentation]({{< ref "filesystem/#localstack-volume" >}}) for specific instructions.
 
 **Workarounds for older (<v3.7.0) LocalStack versions:**
 

content/en/getting-started/help-and-support/index.md

@@ -31,22 +31,22 @@ At the moment, we only provide support in `English`, as we are an international
 
 ## Support Coverage
 
-| Plan       | Tier                                                                                                         |
-| ---------- | ------------------------------------------------------------------------------------------------------------ |
-| Free       | [**Basic Support**](https://docs.localstack.cloud/getting-started/help-and-support/#basic-support)           |
-| Trial      | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support)     |
-| Base       | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support)     |
-| Ultimate   | [**Priority Support**](https://docs.localstack.cloud/getting-started/help-and-support/#priority-support)     |
-| Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/getting-started/help-and-support/#enterprise-support) |
+| Plan       | Tier                                                                                          |
+| ---------- | --------------------------------------------------------------------------------------------- |
+| Free       | [**Basic Support**]({{< ref "/getting-started/help-and-support/#basic-support" >}})           |
+| Trial      | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}})     |
+| Base       | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}})     |
+| Ultimate   | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}})     |
+| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) |
 
 ## Support Coverage for legacy plans
 
-| Plan       | Tier                                                                                                         |
-| ---------- | ------------------------------------------------------------------------------------------------------------ |
-| Hobby      | [**Basic Support**](https://docs.localstack.cloud/getting-started/help-and-support/#basic-support)           |
-| Starter    | [**Standard Support**](https://docs.localstack.cloud/getting-started/help-and-support/#standard-support)     |
-| Teams      | [**Priority Support**](https://docs.localstack.cloud/getting-started/help-and-support/#priority-support)     |
-| Enterprise | [**Enterprise Support**](https://docs.localstack.cloud/getting-started/help-and-support/#enterprise-support) |
+| Plan       | Tier                                                                                          |
+| ---------- | --------------------------------------------------------------------------------------------- |
+| Hobby      | [**Basic Support**]({{< ref "/getting-started/help-and-support/#basic-support" >}})           |
+| Starter    | [**Standard Support**]({{< ref "/getting-started/help-and-support/#standard-support" >}})     |
+| Teams      | [**Priority Support**]({{< ref "/getting-started/help-and-support/#priority-support" >}})     |
+| Enterprise | [**Enterprise Support**]({{< ref "/getting-started/help-and-support/#enterprise-support" >}}) |
 
 ## Support features
 

content/en/getting-started/installation.md

@@ -449,7 +449,7 @@ $ python3 -m localstack.cli.main
 #### The `localstack` CLI does not start the LocalStack container
 
 If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
-- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](https://docs.localstack.cloud/user-guide/tools/dns-server/#system-dns-configuration) to disable it.
+- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation]({{< ref "dns-server/#system-dns-configuration" >}}) to disable it.
 - Start LocalStack with a specific DNS address:
 {{< command >}}
 $ DNS_ADDRESS=0 localstack start

content/en/getting-started/quickstart/index.md

@@ -41,11 +41,11 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur
 
 ## Prerequisites
 
-- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli)
-- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/)
+- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}})
+- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token]({{< ref "/getting-started/auth-token/" >}})
 - [Docker](https://docs.docker.com/get-docker/)
 - [Python 3.11+](https://www.python.org/downloads/) & `pip`
-- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
+- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper]({{< ref "/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal" >}})
 - `jq`, `zip` & `curl`
 
 You can start LocalStack using the `localstack` CLI.
@@ -105,7 +105,7 @@ $ pyenv global 3.11
 
 ### Setup the serverless image resizer
 
-This application enables serverless image resizing using [S3](https://docs.localstack.cloud/user-guide/aws/s3/), [SSM](https://docs.localstack.cloud/user-guide/aws/ssm/), [Lambda](https://docs.localstack.cloud/user-guide/aws/lambda/), [SNS](https://docs.localstack.cloud/user-guide/aws/sns/), and [SES](https://docs.localstack.cloud/user-guide/aws/ses/).
+This application enables serverless image resizing using [S3]({{< ref "/user-guide/aws/s3/" >}}), [SSM]({{< ref "/user-guide/aws/ssm" >}}/), [Lambda]({{< ref "/user-guide/aws/lambda" >}}/), [SNS]({{< ref "/user-guide/aws/sns" >}}/), and [SES]({{< ref "/user-guide/aws/ses" >}}/).
 A simple web interface allows users to upload and view resized images.
 A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing.
 Another Lambda function lists and provides pre-signed URLs for browser display.
@@ -128,7 +128,7 @@ $ deployment/awslocal/deploy.sh
 Alternatively, you can follow these instructions to deploy the sample application manually step-by-step.
 
 {{< callout "tip" >}}
-In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-an-endpoint-url) or a [custom profile](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#configuring-a-custom-profile) like `localstack`.
+In absence of the `awslocal` wrapper, you can use the `aws` CLI directly, by configuring an [endpoint URL]({{< ref "/user-guide/integrations/aws-cli/#configuring-an-endpoint-url" >}}) or a [custom profile]({{< ref "/user-guide/integrations/aws-cli/#configuring-a-custom-profile" >}}) like `localstack`.
 You can then swap `awslocal` with `aws --endpoint-url=http://localhost:4566` or `aws --profile=localstack` in the commands below.
 {{< /callout >}}
 

content/en/references/api-key.md

@@ -51,7 +51,7 @@ You can optionally run your LocalStack container in background mode by adding th
 The `localstack` CLI will detect the API key and properly pass it to the LocalStack container.
 
 {{< callout >}}
-If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image](https://docs.localstack.cloud/references/docker-images/#localstack-pro-image) that includes the Pro services and several other advanced features.
+If you are using LocalStack with an API Key, you need to pull the [LocalStack Pro image]({{< ref "docker-images/#localstack-pro-image" >}}) that includes the Pro services and several other advanced features.
 {{< /callout >}}
 
 ### Starting LocalStack via Docker
@@ -67,7 +67,7 @@ $ docker run \
   localstack/localstack-pro
 {{< / command >}}
 
-For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide.
+For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "installation/#docker" >}}) guide.
 
 ### Starting LocalStack via Docker-Compose
 

content/en/references/configuration.md

@@ -332,8 +332,8 @@ Please consult the [migration guide]({{< ref "user-guide/aws/lambda#migrating-to
 | - | - | - |
 | `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
 | `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
-| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`](https://docs.localstack.cloud/user-guide/aws/sqs/#enabling-messageretentionperiod) |
-| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs](https://docs.localstack.cloud/user-guide/aws/sqs/#queue-urls) |
+| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`]({{< ref "sqs/#enabling-messageretentionperiod" >}}) |
+| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs]({{< ref "sqs/#queue-urls" >}}) |
 | `SQS_DISABLE_CLOUDWATCH_METRICS` | `0` (default) | Disables the CloudWatch Metrics for SQS when set to `1` |
 | `SQS_CLOUDWATCH_METRICS_REPORT_INTERVAL` | `60` (default) | Configures the report interval (in seconds) for `Approximate*` metrics that are sent to CloudWatch periodically. Sending will be disabled if `SQS_DISABLE_CLOUDWATCH_METRICS=1` |
 
@@ -501,9 +501,9 @@ These configurations have already been removed and **won't have any effect** on
 | `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` |  Local directory for saving persistent data. Use `PERSISTENCE` instead. |
 | `DISABLE_TERM_HANDLER` | 2.0.0 | `""` (default) \| `1` | Whether to disable signal passing to LocalStack when running in docker. Enabling this will prevent an orderly shutdown when running inside LS in docker. Setting this to anything else than an empty string will disable it.
 | `HOST_TMP_FOLDER` | 2.0.0 | `/some/path` |  Temporary folder on the host that gets mounted as `$TMPDIR/localstack` into the LocalStack container. Required only for Lambda volume mounts when using `LAMBDA_REMOTE_DOCKER=false.` |
-| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). |
+| `INIT_SCRIPTS_PATH` | 2.0.0 | `/some/path` | Before 1.0, this was used to configure the path to the initializing files with extensions `.sh` that were found in `/docker-entrypoint-initaws.d`. This has been replaced by the [init-hook system]({{< ref "init-hooks" >}}). |
 | `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout]({{< ref "filesystem" >}}). |
-| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system](https://docs.localstack.cloud/references/init-hooks/). |
+| `LEGACY_INIT_DIR` | 2.0.0 | `1` \| `0`(default) | Used with `INIT_SCRIPTS_PATH`. This has been replaced by the [init-hook system]({{< ref "init-hooks" >}}). |
 | `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
 | `SQS_PROVIDER` | 2.0.0 |  `moto` (default) and `elasticmq` | |
 | `SYNCHRONOUS_API_GATEWAY_EVENTS` | 2.0.0 | `1` (default) \| `0` | Whether or not to handle API Gateway Lambda event sources as synchronous invocations. |

content/en/references/docker-images.md

@@ -24,12 +24,12 @@ $ docker pull localstack/localstack:latest
 
 To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud).
 The Community image is free to use and does not require a license to run.
-The Community image can be used to run [local AWS services](https://docs.localstack.cloud/user-guide/aws/) with [integrations](https://docs.localstack.cloud/user-guide/integrations/) on your local machine or in your [continuous integration pipelines](https://docs.localstack.cloud/user-guide/ci/).
+The Community image can be used to run [local AWS services]({{< ref "user-guide/aws" >}}) with [integrations]({{< ref "/user-guide/integrations" >}}) on your local machine or in your [continuous integration pipelines]({{< ref "/user-guide/ci" >}}).
 
-The Community image also covers a limited set of [LocalStack Tools](https://docs.localstack.cloud/user-guide/tools/) to make your life as a cloud developer easier.
-You can use [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/) or [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/) to use LocalStack with a graphical user interface.
+The Community image also covers a limited set of [LocalStack Tools]({{< ref "/user-guide/tools" >}}) to make your life as a cloud developer easier.
+You can use [LocalStack Desktop]({{< ref "/user-guide/tools/localstack-desktop/" >}}) or [LocalStack Docker Extension]({{< ref "/user-guide/tools/localstack-docker-extension/" >}}) to use LocalStack with a graphical user interface.
 
-You can use the Community image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
+You can use the Community image to start your LocalStack container using various [installation methods]({{< ref "/getting-started/installation/" >}}).
 While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack` image with the appropriate tag you have pulled (if not `latest`).
 
 ## LocalStack Pro image
@@ -44,9 +44,9 @@ $ docker pull localstack/localstack-pro:latest
 
 To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your Auth Token.
 The LocalStack Pro image will display a warning if you do not set an Auth Token (or if the license is invalid/expired) and will not activate the Pro features.
-LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support](https://docs.localstack.cloud/getting-started/help-and-support/#pro-support).
+LocalStack Pro gives you access to the complete set of LocalStack features, including the [LocalStack Web Application](https://app.localstack.cloud) and [dedicated customer support]({{< ref "/getting-started/help-and-support/#pro-support" >}}).
 
-You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
+You can use the Pro image to start your LocalStack container using various [installation methods]({{< ref "installation" >}}).
 While configuring to run LocalStack with Docker or Docker Compose, run the `localstack/localstack-pro` image with the appropriate tag you have pulled (if not `latest`).
 
 {{< callout >}}