Skip to content

Commit 41ced7d

Browse files
viren-nadkarniviren-nadkarni
committed
Replace hardcoded URLs with ref shortcodes
1 parent 4cee4db commit 41ced7d

File tree

71 files changed

+107
-107
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+107
-107
lines changed

‎content/en/getting-started/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To resolve the issue follow the steps:
1818
This can be done by deleting the cached certificate file.
1919
For example, on Linux systems, you can locate and remove the file at `~/.cache/localstack/volume/cache/server.test.pem`.
2020
The exact path may differ depending on your operating system and how you’ve started LocalStack.
21-
Please refer to our [documentation](https://docs.localstack.cloud/references/filesystem/#localstack-volume) for specific instructions.
21+
Please refer to our [documentation]({{< ref "filesystem/#localstack-volume" >}}) for specific instructions.
2222

2323
**Workarounds for older (<v3.7.0) LocalStack versions:**
2424

‎content/en/getting-started/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -449,7 +449,7 @@ $ python3 -m localstack.cli.main
449449
#### The `localstack` CLI does not start the LocalStack container
450450

451451
If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
452-
- 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.
452+
- 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.
453453
- Start LocalStack with a specific DNS address:
454454
{{< command >}}
455455
$ DNS_ADDRESS=0 localstack start

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur
4141

4242
## Prerequisites
4343

44-
- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli)
45-
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/)
44+
- [LocalStack CLI]({{< ref "/getting-started/installation/#localstack-cli" >}})
45+
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token]({{< ref "/getting-started/auth-token/" >}})
4646
- [Docker](https://docs.docker.com/get-docker/)
4747
- [Python 3.11+](https://www.python.org/downloads/) & `pip`
48-
- [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)
48+
- [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" >}})
4949
- `jq`, `zip` & `curl`
5050

5151
You can start LocalStack using the `localstack` CLI.
@@ -105,7 +105,7 @@ $ pyenv global 3.11
105105

106106
### Setup the serverless image resizer
107107

108-
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/).
108+
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" >}}/).
109109
A simple web interface allows users to upload and view resized images.
110110
A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing.
111111
Another Lambda function lists and provides pre-signed URLs for browser display.
@@ -128,7 +128,7 @@ $ deployment/awslocal/deploy.sh
128128
Alternatively, you can follow these instructions to deploy the sample application manually step-by-step.
129129

130130
{{< callout "tip" >}}
131-
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`.
131+
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`.
132132
You can then swap `awslocal` with `aws --endpoint-url=http://localhost:4566` or `aws --profile=localstack` in the commands below.
133133
{{< /callout >}}
134134

‎content/en/references/api-key.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ You can optionally run your LocalStack container in background mode by adding th
5151
The `localstack` CLI will detect the API key and properly pass it to the LocalStack container.
5252

5353
{{< callout >}}
54-
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.
54+
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.
5555
{{< /callout >}}
5656

5757
### Starting LocalStack via Docker
@@ -67,7 +67,7 @@ $ docker run \
6767
localstack/localstack-pro
6868
{{< / command >}}
6969

70-
For more information about starting LocalStack with Docker, take a look at our [Docker installation](https://docs.localstack.cloud/getting-started/installation/#docker) guide.
70+
For more information about starting LocalStack with Docker, take a look at our [Docker installation]({{< ref "installation/#docker" >}}) guide.
7171

7272
### Starting LocalStack via Docker-Compose
7373

‎content/en/references/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -332,8 +332,8 @@ Please consult the [migration guide]({{< ref "user-guide/aws/lambda#migrating-to
332332
| - | - | - |
333333
| `SQS_DELAY_PURGE_RETRY` | `0` (default) | Used to toggle PurgeQueueInProgress errors when making more than one PurgeQueue call within 60 seconds. |
334334
| `SQS_DELAY_RECENTLY_DELETED` | `0` (default) | Used to toggle QueueDeletedRecently errors when re-creating a queue within 60 seconds of deleting it. |
335-
| `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) |
336-
| `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) |
335+
| `SQS_ENABLE_MESSAGE_RETENTION_PERIOD`| `0` (default) \| `1` | Used to toggle the MessageRetentionPeriod feature (see [Enabling `MessageRetentionPeriod`]({{< ref "sqs/#enabling-messageretentionperiod" >}}) |
336+
| `SQS_ENDPOINT_STRATEGY`| `standard` (default) \| `domain` \| `path` \| `off` | Configures the format of Queue URLs (see [SQS Queue URLs]({{< ref "sqs/#queue-urls" >}}) |
337337
| `SQS_DISABLE_CLOUDWATCH_METRICS` | `0` (default) | Disables the CloudWatch Metrics for SQS when set to `1` |
338338
| `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` |
339339

@@ -501,9 +501,9 @@ These configurations have already been removed and **won't have any effect** on
501501
| `DATA_DIR`| 2.0.0 | blank (disabled/default), `/tmp/localstack/data` | Local directory for saving persistent data. Use `PERSISTENCE` instead. |
502502
| `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.
503503
| `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.` |
504-
| `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/). |
504+
| `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" >}}). |
505505
| `LEGACY_DIRECTORIES` | 2.0.0 | `0` (default) | Use legacy method of managing internal filesystem layout. See [Filesystem Layout]({{< ref "filesystem" >}}). |
506-
| `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/). |
506+
| `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" >}}). |
507507
| `MULTI_ACCOUNTS` | 2.0.0 | `0` (default) | Enable multi-accounts (preview) |
508508
| `SQS_PROVIDER` | 2.0.0 | `moto` (default) and `elasticmq` | |
509509
| `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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ $ docker pull localstack/localstack:latest
2424

2525
To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud).
2626
The Community image is free to use and does not require a license to run.
27-
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/).
27+
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" >}}).
2828

29-
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.
30-
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.
29+
The Community image also covers a limited set of [LocalStack Tools]({{< ref "/user-guide/tools" >}}) to make your life as a cloud developer easier.
30+
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.
3131

32-
You can use the Community image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
32+
You can use the Community image to start your LocalStack container using various [installation methods]({{< ref "/getting-started/installation/" >}}).
3333
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`).
3434

3535
## LocalStack Pro image
@@ -44,9 +44,9 @@ $ docker pull localstack/localstack-pro:latest
4444

4545
To use the LocalStack Pro image, you must configure an environment variable named `LOCALSTACK_AUTH_TOKEN` to contain your Auth Token.
4646
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.
47-
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).
47+
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" >}}).
4848

49-
You can use the Pro image to start your LocalStack container using various [installation methods](https://docs.localstack.cloud/getting-started/installation/).
49+
You can use the Pro image to start your LocalStack container using various [installation methods]({{< ref "installation" >}}).
5050
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`).
5151

5252
{{< callout >}}

‎content/en/references/logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,5 +66,5 @@ With Docker/Docker-Compose, you can run `docker ps` to get the container ID of t
6666

6767
To view the logs via a user interface, you can use the following options:
6868

69-
- [LocalStack Desktop](https://docs.localstack.cloud/user-guide/tools/localstack-desktop/)
70-
- [LocalStack Docker Extension](https://docs.localstack.cloud/user-guide/tools/localstack-docker-extension/)
69+
- [LocalStack Desktop]({{< ref "localstack-desktop" >}})
70+
- [LocalStack Docker Extension]({{< ref "localstack-docker-extension" >}})

‎content/en/references/usage-tracking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ It is tracked regardless of whether the user disables event tracking since we co
1515

1616
## LocalStack usage statistics
1717

18-
For Pro users, most of the information is collected to populate the [Stack Insights](https://docs.localstack.cloud/user-guide/web-application/stack-insights) dashboard.
18+
For Pro users, most of the information is collected to populate the [Stack Insights]({{ ref "stack-insights" >}}) dashboard.
1919
Collecting basic anonymized usage of AWS services helps us better direct engineering efforts to services that are used the most or cause the most issues.
2020

2121
### Session information

‎content/en/tutorials/lambda-ecr-container-images/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Before diving into this tutorial, make sure you have the following prerequisites
4343

4444
- LocalStack Pro
4545
- [awslocal]({{< ref "aws-cli#localstack-aws-cli-awslocal" >}})
46-
- [`awslocal` CLI](https://docs.localstack.cloud/user-guide/integrations/aws-cli/#localstack-aws-cli-awslocal)
46+
- [`awslocal` CLI](<{{ ref "aws-cli/#localstack-aws-cli-awslocal" >}})
4747
- [Python](https://www.python.org/downloads/)
4848
- [Docker](https://docker.io/)
4949

‎content/en/tutorials/replicate-aws-resources-localstack-extension/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In this tutorial, you will learn how to install the AWS Replicator extension and
3434

3535
## Prerequisites
3636

37-
- [LocalStack CLI](https://docs.localstack.cloud/getting-started/installation/#localstack-cli) with [`LOCALSTACK_AUTH_TOKEN`](https://docs.localstack.cloud/getting-started/auth-token/)
37+
- [LocalStack CLI]({{< ref "installation/#localstack-cli" >}}) with [`LOCALSTACK_AUTH_TOKEN`]({{< ref "auth-token" >}})
3838
- [Docker](https://docs.localstack.cloud/getting-started/auth-token/)
3939
- [AWS CLI](https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-install.html) with [`awslocal` wrapper](https://github.com/localstack/awscli-local)
4040
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up)

‎content/en/tutorials/schema-evolution-glue-msk/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following chart shows the integration of producers and consumers with Amazon
5353
3. The consumer reads the serialized and compressed record.
5454
4. The consumer requests the schema from the schema registry (if it is not already cached) and uses the schema to decompress and deserialize the record.
5555

56-
[AWS Glue Schema Registry](https://docs.localstack.cloud/user-guide/aws/glue/) is supported by LocalStack Pro as well, ultimately allowing you to test the evolution of your data streaming application completely on your local machine.
56+
[AWS Glue Schema Registry]({{< ref "glue" >}}) is supported by LocalStack Pro as well, ultimately allowing you to test the evolution of your data streaming application completely on your local machine.
5757
It allows you develop and test your application's data schema evolution locally.
5858
The code for this tutorial (including a script to execute it step-by-step) can be found in our [LocalStack Pro samples over GitHub](https://github.com/localstack/localstack-pro-samples/tree/master/glue-msk-schema-registry).
5959

‎content/en/user-guide/aws/account/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use the Account APIs to retrieve information about your account, manage
1111
Additionally, you can use the Account APIs to enable or disable a region for your account, and delete alternate contacts in your account.
1212

1313
LocalStack supports Account via the Pro offering, allowing you to use the Account API to retrieve information about your account.
14-
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_account/), which provides information on the extent of Account's integration with LocalStack.
14+
The supported APIs are available on our [API coverage page]({{< ref "coverage_account" >}}), which provides information on the extent of Account's integration with LocalStack.
1515

1616
{{< callout >}}
1717
LocalStack's Account provider is mock-only and does not support any real AWS account.

‎content/en/user-guide/aws/acm/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ACM supports securing multiple domain names and subdomains and can create wildca
1313
You can also use ACM to import certificates from third-party certificate authorities or to generate private certificates for internal use.
1414

1515
LocalStack allows you to use the ACM APIs to create, list, and delete certificates.
16-
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_acm/), which provides information on the extent of ACM's integration with LocalStack.
16+
The supported APIs are available on our [API coverage page]({{< ref "coverage_acm" >}}), which provides information on the extent of ACM's integration with LocalStack.
1717

1818
## Getting started
1919

‎content/en/user-guide/aws/appsync/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ AppSync is a managed service provided by Amazon Web Services (AWS) that enables
1111
AppSync allows you to define your data models and business logic using a declarative approach, and connect to various data sources, including other AWS services, relational databases, and custom data sources.
1212

1313
LocalStack allows you to use the AppSync APIs in your local environment to connect your applications and services to data and events.
14-
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_appsync/), which provides information on the extent of AppSync's integration with LocalStack.
14+
The supported APIs are available on our [API coverage page]({{< ref "coverage_appsync" >}}), which provides information on the extent of AppSync's integration with LocalStack.
1515

1616
## Getting started
1717

‎content/en/user-guide/aws/athena/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Athena allows users to create ad-hoc queries to perform data analysis, filter, a
1212
It supports various file formats, such as JSON, Parquet, and CSV, making it compatible with a wide range of data sources.
1313

1414
LocalStack allows you to configure the Athena APIs with a Hive metastore that can connect to the S3 API and query your data directly in your local environment.
15-
The supported APIs are available on our [API coverage page](https://docs.localstack.cloud/references/coverage/coverage_athena/), which provides information on the extent of Athena's integration with LocalStack.
15+
The supported APIs are available on our [API coverage page]({{< ref "coverage_athena" >}}), which provides information on the extent of Athena's integration with LocalStack.
1616

1717
## Getting started
1818

0 commit comments

Comments
 (0)