Skip to content

Commit 89ce694

Browse files
quetzalliwritesHarshCasper
quetzalliwrites
and
HarshCasper
authored
docs: QA each doc page for both aws + snow (#42)
* finished QAing Getting Started * finished fixing aws docs * finished fixing snow docs * fix broken link * Update localstack-docker-extension.md * fix --------- Co-authored-by: Harsh Mishra <erbeusgriffincasper@gmail.com>
1 parent e5dac7d commit 89ce694

File tree

26 files changed

+111
-40
lines changed

26 files changed

+111
-40
lines changed

‎src/content/docs/aws/capabilities/config/docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ docker pull localstack/localstack:latest
2121

2222
To use the LocalStack Community image, you don't need to sign-up for an account on [LocalStack Web Application](https://app.localstack.cloud).
2323
The Community image is free to use and does not require a license to run.
24-
The Community image can be used to run [local AWS services](/aws/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/).
24+
The Community image can be used to run [local AWS services](/aws/services/) with [integrations](/aws/integrations/) on your local machine or in your [continuous integration pipelines](/aws/integrations/continuous-integration/).
2525

2626
The Community image also covers a limited set of [LocalStack Tools](/aws/tooling/) to make your life as a cloud developer easier.
2727
You can use [LocalStack Desktop](/aws/capabilities/web-app/localstack-desktop/) or [LocalStack Docker Extension](/aws/tooling/localstack-docker-extension) to use LocalStack with a graphical user interface.

‎src/content/docs/aws/capabilities/config/podman.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ template: doc
77
## Introduction
88

99
By default, the LocalStack CLI starts the LocalStack runtime inside a Docker container.
10-
Docker may not be available on your system, and a popular alternative is [Podman](https://podman.io/getting-started/) which you can use to run LocalStack.
10+
Docker may not be available on your system, and a popular alternative is [Podman](https://podman.io/get-started) which you can use to run LocalStack.
1111
Podman support is still experimental, and the following docs give you an overview of the current state.
1212

1313
From the Podman docs:
@@ -32,7 +32,7 @@ It creates the following links:
3232
- `/var/run/docker.sock -> /run/podman/podman.sock`
3333

3434
This package is available for some distros:
35-
- https://archlinux.org/packages/community/x86_64/podman-docker/
35+
- https://archlinux.org/packages/extra/x86_64/podman-docker/
3636
- https://packages.ubuntu.com/oracular/podman-docker
3737
- https://packages.debian.org/sid/podman-docker
3838

‎src/content/docs/aws/capabilities/state-management/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Overview
3-
description: Cloud Pods provides a new way of collaborating in cloud application development workflows.
3+
description: State Management in LocalStack allows you to save and load the state of your LocalStack instance.
44
template: doc
55
sidebar:
66
order: 1

‎src/content/docs/aws/enterprise/k8s-operator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ _Appears in:_
7474
| `kind` _string_ | `LocalStack`
7575
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br /><br />Servers may infer this from the endpoint the client submits requests to.<br /><br />Cannot be updated.<br /><br />In CamelCase.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
7676
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br /><br />Servers should convert recognized schemas to the latest internal value, and<br /><br />may reject unrecognized values.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
77-
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
77+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/object-meta/)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
7878
| `spec` _[LocalStackSpec](#localstackspec)_ | |
7979
| `status` _[LocalStackStatus](#localstackstatus)_ | |
8080

@@ -88,7 +88,7 @@ LocalStackList contains a list of LocalStack
8888
| `kind` _string_ | `LocalStackList`
8989
| `kind` _string_ | Kind is a string value representing the REST resource this object represents.<br /><br />Servers may infer this from the endpoint the client submits requests to.<br /><br />Cannot be updated.<br /><br />In CamelCase.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
9090
| `apiVersion` _string_ | APIVersion defines the versioned schema of this representation of an object.<br /><br />Servers should convert recognized schemas to the latest internal value, and<br /><br />may reject unrecognized values.<br /><br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
91-
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v/#listmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
91+
| `metadata` _[ListMeta](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/list-meta/)_ | Refer to Kubernetes API documentation for fields of `metadata`. |
9292
| `items` _[LocalStack](#localstack) array_ | |
9393

9494
#### LocalStackSpec

‎src/content/docs/aws/enterprise/kubernetes-executor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ Lambda hot reloading & remote debugging are not supported in the Kubernetes exec
6161

6262
You can run the following services on Kubernetes clusters using the LocalStack Enterprise image:
6363

64-
- [DocumentDB](https://docs.localstack.cloud/user-guide/aws/docdb/)
65-
- [MWAA](https://docs.localstack.cloud/user-guide/aws/docdb/)
66-
- [RDS](https://docs.localstack.cloud/user-guide/aws/rds/) ([MySQL](https://docs.localstack.cloud/user-guide/aws/rds/#mysql-engine) & [MSSQL](https://docs.localstack.cloud/user-guide/aws/rds/#microsoft-sql-server-engine))
64+
- [DocumentDB](/aws/services/docdb)
65+
- [MWAA](/aws/services/docdb)
66+
- [RDS](/aws/services/rds) ([MySQL](/aws/services/rds/#mysql-engine) & [MSSQL](/aws/services/rds/#microsoft-sql-server-engine))
6767

6868
To use Kubernetes as the runtime backend, set the `CONTAINER_RUNTIME` configuration variable to `kubernetes`.
6969
Note that there are no service-specific configuration variables for these services.

‎src/content/docs/aws/getting-started/auth-token.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ You have the option to run your LocalStack container in the background by append
9797
The `localstack` CLI automatically detects the Auth Token and appropriately conveys it to the LocalStack container.
9898

9999
:::note
100-
If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](aws/capabilities/config/docker-images/#localstack-pro-image), which includes Pro services and several advanced features.
100+
If you are using LocalStack with an Auth Token, it's necessary to download the [LocalStack Pro image](/aws/capabilities/config/docker-images#localstack-pro-image), which includes Pro services and several advanced features.
101101
:::
102102

103103
### Docker
@@ -113,7 +113,7 @@ $ docker run \
113113
localstack/localstack-pro
114114
```
115115

116-
For more information about starting LocalStack with Docker, take a look at our [Docker installation](aws/getting-started/installation/#docker) guide.
116+
For more information about starting LocalStack with Docker, take a look at our [Docker installation](/aws/getting-started/installation/#docker) guide.
117117

118118
### Docker Compose
119119

‎src/content/docs/aws/getting-started/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ With LocalStack, you can run your AWS applications or Lambdas entirely on your l
1212

1313
Whether you are testing complex CDK applications or Terraform configurations, or just beginning to learn about AWS services, LocalStack helps speed up and simplify your testing and development workflow.
1414

15-
LocalStack supports a growing number of [AWS services](/aws/)
15+
LocalStack supports a growing number of [AWS services](/aws/services/)
1616
, like [Lambda](/aws/services/lambda), [S3](/aws/services/s3), [DynamoDB](/aws/services/dynamodb), [Kinesis](/aws/services/kinesis), [SQS](/aws/services/sqs), [SNS](/aws/services/sns), and more!
1717
[LocalStack Pro](https://localstack.cloud/pricing) supports additional APIs and advanced features to make your cloud development experience a breeze!
1818

‎src/content/docs/aws/getting-started/installation.mdx

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

437437
If you are using the `localstack` CLI to start LocalStack, but the container is not starting, please check the following:
438-
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](aws/tooling/dns-server/#system-dns-configuration) to disable it.
438+
- Uncheck the **Use kernel networking for UDP** option in Docker Desktop (**Settings** → **Resources** → **Network**) or follow the steps in our [documentation](/aws/tooling/dns-server#system-dns-configuration) to disable it.
439439
- Start LocalStack with a specific DNS address:
440440
```bash
441441
DNS_ADDRESS=0 localstack start

‎src/content/docs/aws/getting-started/quickstart.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ An internal SES LocalStack testing endpoint (`/_localstack/aws/ses`) is configur
3939
## Prerequisites
4040

4141
- [LocalStack CLI](/aws/getting-started/installation/#installing-localstack-cli)
42-
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](https://docs.localstack.cloud/getting-started/auth-token/)
42+
- [LocalStack Web Application account](https://app.localstack.cloud/sign-up) & [Auth Token](/aws/getting-started/auth-token/)
4343
- [Docker](https://docs.docker.com/get-docker/)
4444
- [Python 3.11+](https://www.python.org/downloads/) & `pip`
45-
- [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)
45+
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) & [`awslocal` wrapper](/aws/integrations/aws-native-tools/aws-cli/#localstack-aws-cli-awslocal)
4646
- `jq`, `zip` & `curl`
4747

4848
You can start LocalStack using the `localstack` CLI.
@@ -104,7 +104,7 @@ pyenv global 3.11
104104

105105
### Setup the serverless image resizer
106106

107-
This application enables serverless image resizing using [S3](/aws/services/s3/), [SSM](/aws/services/ssm/), [Lambda](/aws/services/lambda/), [SNS](aws/services/sns/), and [SES](/aws/services/ses/).
107+
This application enables serverless image resizing using [S3](/aws/services/s3/), [SSM](/aws/services/ssm/), [Lambda](/aws/services/lambda/), [SNS](/aws/services/sns/), and [SES](/aws/services/ses/).
108108
A simple web interface allows users to upload and view resized images.
109109
A Lambda function generates S3 pre-signed URLs for direct uploads, while S3 bucket notifications trigger image resizing.
110110
Another Lambda function lists and provides pre-signed URLs for browser display.
@@ -356,6 +356,6 @@ To expand your LocalStack capabilities, explore the following based on your expe
356356

357357
- [Tutorials](/aws/tutorials): Check out our tutorials to learn how to use LocalStack across various AWS services and application stacks.
358358
- [Supported Services](/aws/services): Explore LocalStack's emulated AWS services.
359-
- [Capabilities](): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more.
360-
- [Tooling](): Get details on LocalStack's tooling and integrations.
359+
- [Capabilities](/aws/capabilities/): Learn about LocalStack's capabilities including features like IAM policy stream, state management, and more.
360+
- [Tooling](/aws/tooling/): Get details on LocalStack's tooling and integrations.
361361
- [Blog](https://blog.localstack.cloud): Read our blog posts about LocalStack and the latest enhancements for a better local development and testing experience.

‎src/content/docs/aws/integrations/app-frameworks/serverless-framework.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In particular, the setup consists of the following two steps.
2020

2121
This guide assumes that you have the following tools installed.
2222

23-
* LocalStack ([Install](https://docs.localstack.cloud/get-started/#installation))
23+
* LocalStack ([Install](/aws/getting-started/installation))
2424
* Serverless ([Install](https://www.serverless.com/framework/docs/getting-started/))
2525

2626
It also assumes that you already have a Serverless app set up consisting of a couple of Lambda functions and a `serverless.yml` file similar to the following.

0 commit comments

Comments
 (0)