Skip to content

Commit 304819d

Browse files
authored
Fix/quickstart (#476)
* docs: inserting cloudpods sample link * docs: added link to relevant quickstart sample * dev: added devcontainer setup for VSCode and workspace extensions
1 parent 611718f commit 304819d

File tree

5 files changed

+55
-2
lines changed

5 files changed

+55
-2
lines changed

.devcontainer/devcontainer.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/debian
3+
{
4+
"name": "Debian",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/base:bullseye",
7+
"features": {
8+
"ghcr.io/devcontainers/features/go:1": {},
9+
"ghcr.io/devcontainers/features/hugo:1": {
10+
"extended": true
11+
}
12+
},
13+
"customizations": {
14+
"vscode": {
15+
"extensions": [
16+
"budparr.language-hugo-vscode",
17+
"rusnasonov.vscode-hugo",
18+
"streetsidesoftware.code-spell-checker"
19+
]
20+
}
21+
}
22+
23+
// Features to add to the dev container. More info: https://containers.dev/features.
24+
// "features": {},
25+
26+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
27+
// "forwardPorts": [],
28+
29+
// Configure tool-specific properties.
30+
// "customizations": {},
31+
32+
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
33+
// "remoteUser": "root"
34+
}

.vscode/extensions.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"recommendations": [
3+
"budparr.language-hugo-vscode",
4+
"rusnasonov.vscode-hugo",
5+
"streetsidesoftware.code-spell-checker"
6+
]
7+
}

.vscode/settings.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"cSpell.words": [
3+
"awslocal",
4+
"quickstart"
5+
]
6+
}

content/en/getting-started/quickstart.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@ This quickstart guide will walk you through starting LocalStack on your local ma
1212

1313
{{< alert title="Note" >}}
1414
The quickest way to experiment with LocalStack is to use one of our [LocalStack quickstart samples](https://app.localstack.cloud/quickstart) to deploy a thumbnail creator, request worker application, or an asynchronous microservice with tracing/debugging. The quickstart samples will automatically connect to your running LocalStack container on your local machine and run the applications.
15+
16+
To quickly see the outcome of this quickstart guide, try deploying the [Request Worker](https://app.localstack.cloud/quickstart-cloudformation) sample from our website.
1517
{{< /alert >}}
1618

1719
## Start your LocalStack container
1820

1921
After installing LocalStack and configuring your API key, let us start LocalStack. To run our sample AWS application, we will start LocalStack using the `localstack` CLI.
2022

2123
{{< command >}}
22-
$ localstack start
24+
$ localstack start
2325
{{< / command >}}
2426

2527
You can optionally run your LocalStack container in background mode by adding the `-d` flag to the `localstack start` command.

content/en/user-guide/tools/cloud-pods/_index.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,18 @@ aliases:
99
---
1010

1111
{{< alert title="Note">}}
12-
Please note that cloud pods may not be compatibile across different versions of LocalStack.
12+
Please note that cloud pods may not be compatible across different versions of LocalStack.
1313
We are actively working on addressing this limitation in the upcoming releases.
1414
{{< /alert >}}
1515

1616
Cloud Pods are a mechanism that allows you to take a snapshot of the state in your current LocalStack instance, persist it to a storage backend, and easily share it with your team members.
1717

1818
![Persistence versus Cloud Pods](pods-persistence.png)
1919

20+
{{< alert title="Demo">}}
21+
To quickly see cloud pods in action, we prepared a small sample application that uses cloud pods to inject its state into a running LocalStack container. [Cloud Pod Thumbnail Sample App](https://app.localstack.cloud/quickstart/demo4)
22+
{{< /alert >}}
23+
2024
While the [Persistence]({{< ref "persistence-mechanism" >}}) feature ensures that the service state survives container restarts, Cloud Pods go beyond and allow more fine-grained control over your state.
2125

2226
Instead of simply restoring a state when restarting LocalStack, Cloud Pods allow you to take snapshots of your local instance (with the `save` command) and inject such snapshots into a running instance (with the `load` command) without requiring a restart.

0 commit comments

Comments
 (0)