Skip to content

Commit 874efa1

Browse files
Upgrade to latest starlight (#647)
Co-authored-by: Quetzalli <hola@quetzalliwrites.com>
1 parent 6ed81ae commit 874efa1

8 files changed

Lines changed: 568 additions & 587 deletions

File tree

astro.config.mjs

Lines changed: 200 additions & 84 deletions
Large diffs are not rendered by default.

package-lock.json

Lines changed: 320 additions & 437 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212
"sync:licensing-tags": "node scripts/sync-licensing-tags.mjs"
1313
},
1414
"dependencies": {
15-
"@astrojs/markdoc": "^1.0.3",
16-
"@astrojs/react": "^5.0.2",
15+
"@astrojs/markdoc": "^1.0.4",
16+
"@astrojs/react": "^5.0.4",
1717
"@astrojs/sitemap": "^3.7.2",
18-
"@astrojs/starlight": "^0.38.2",
18+
"@astrojs/starlight": "^0.39.2",
1919
"@astrojs/starlight-docsearch": "^0.7.0",
2020
"@astrojs/starlight-markdoc": "^0.6.0",
2121
"@astrojs/starlight-tailwind": "^5.0.0",
@@ -25,7 +25,7 @@
2525
"@tanstack/react-table": "^8.21.3",
2626
"@types/react": "^19.1.3",
2727
"@types/react-dom": "^19.1.3",
28-
"astro": "^6.1.3",
28+
"astro": "^6.3.1",
2929
"class-variance-authority": "^0.7.1",
3030
"clsx": "^2.1.1",
3131
"lucide-react": "^0.509.0",

src/content/docs/aws/tooling/extensions/developing-extensions.mdx

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Developing extensions
33
description: How to develop your own extensions.
44
template: doc
55
sidebar:
6-
order: 4
7-
tags: ["Hobby"]
6+
order: 3
7+
tags: ['Hobby']
88
---
99

1010
import { FileTree } from '@astrojs/starlight/components';
@@ -199,19 +199,12 @@ version [0.1.0]:
199199
This will create a new Python project with the following layout:
200200

201201
<FileTree>
202-
- my-localstack-extension
203-
- Makefile
204-
- my_localstack_extension
205-
- extension.py
206-
- __init__.py
207-
- README.md
208-
- setup.cfg
209-
- setup.py
202+
- my-localstack-extension - Makefile - my_localstack_extension - extension.py
203+
- __init__.py - README.md - setup.cfg - setup.py
210204
</FileTree>
211205

212206
Then run `make install` in the newly created project to make a distribution package.
213207

214-
215208
#### Using the React template
216209

217210
To create an extension with a React-based UI, use the `--template react` flag:
@@ -231,19 +224,9 @@ version [0.1.0]:
231224
The React template provides a small app with multiple pages to demonstrate how to use multiple pages in the same extension. When you start the LocalStack container with your React-based extension enabled, the extension UI will be automatically available through the LocalStack Web Application.
232225

233226
<FileTree>
234-
- my-localstack-extension
235-
- Makefile
236-
- README.md
237-
- backend
238-
- my_localstack_extension
239-
- backend.pth
240-
- frontend
241-
- \_\_init\_\_.py
242-
- package.json
243-
- public
244-
- src
245-
- tsconfig.json
246-
- pyproject.toml
227+
- my-localstack-extension - Makefile - README.md - backend -
228+
my_localstack_extension - backend.pth - frontend - \_\_init\_\_.py -
229+
package.json - public - src - tsconfig.json - pyproject.toml
247230
</FileTree>
248231

249232
The extension UI will be available at `http://localhost.localstack.cloud:4566/_extension/my-localstack-extension/#/dashboard` when LocalStack is running.

src/content/docs/aws/tooling/extensions/extensions-library.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Extensions Library
33
description: Extend LocalStack by adding new services and features as extensions.
44
template: doc
55
sidebar:
6-
order: 5
7-
tags: ["Hobby"]
6+
order: 4
7+
tags: ['Hobby']
88
---
99

1010
## Introduction
@@ -30,4 +30,4 @@ Click **Continue** to proceed.
3030
You can further manage the installed extensions by navigating to the **Extensions** tab in the LocalStack Instance page.
3131
You can remove an Extension by clicking the **Remove** button.
3232

33-
![Installed LocalStack Extensions Library](/images/aws/extensions-library-management.png)
33+
![Installed LocalStack Extensions Library](/images/aws/extensions-library-management.png)

src/content/docs/aws/tooling/extensions/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@ title: Overview
33
description: Use LocalStack Extensions to customize and extend your local development experience.
44
template: doc
55
sidebar:
6-
order: 1
7-
tags: ["Hobby"]
6+
label: 'Overview'
7+
order: 1
8+
tags: ['Hobby']
89
---
910

1011
LocalStack Extensions let you customize and extend LocalStack's core functionality by running additional logic and services inside the same container. This feature is available across all LocalStack plans, and is ideal for teams that want deeper control over how LocalStack behaves during development or testing.
@@ -30,4 +31,4 @@ Our [MailHog tutorial](/aws/tooling/extensions/mailhog) teaches you how to insta
3031
:::note
3132
The feature and the API are currently in preview stage and may be subject to change.
3233
Please report any issues or feature requests on [LocalStack Extension's GitHub repository](https://github.com/localstack/localstack-extensions).
33-
:::
34+
:::

src/content/docs/aws/tooling/extensions/mailhog.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: MailHog
33
description: Learn how to install and use the official MailHog extension.
44
template: doc
55
sidebar:
6-
order: 2
6+
label: The Mailhog Extension
7+
order: 6
78
tags: ['Hobby']
89
---
910

src/content/docs/aws/tooling/extensions/managing-extensions.mdx

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Managing extensions
33
description: How to manage LocalStack extensions in your LocalStack environment.
44
template: doc
55
sidebar:
6-
order: 3
7-
tags: ["Hobby"]
6+
order: 2
7+
tags: ['Hobby']
88
---
99

1010
import { FileTree } from '@astrojs/starlight/components';
@@ -84,8 +84,8 @@ If you decide to mount a different directory to `/var/lib/localstack` in your do
8484

8585
```yaml
8686
volumes:
87-
- "/tmp/volume:/var/lib/localstack" # LOCALSTACK_VOLUME_DIR mount
88-
- "/var/run/docker.sock:/var/run/docker.sock"
87+
- '/tmp/volume:/var/lib/localstack' # LOCALSTACK_VOLUME_DIR mount
88+
- '/var/run/docker.sock:/var/run/docker.sock'
8989
```
9090
9191
Here's how you can use `LOCALSTACK_VOLUME_DIR` in your commands:
@@ -113,18 +113,18 @@ In a docker-compose file, this would look something like:
113113
```yaml showLineNumbers
114114
services:
115115
localstack:
116-
container_name: "localstack-main"
116+
container_name: 'localstack-main'
117117
image: localstack/localstack-pro
118118
ports:
119-
- "127.0.0.1:4566:4566"
120-
- "127.0.0.1:4510-4559:4510-4559"
119+
- '127.0.0.1:4566:4566'
120+
- '127.0.0.1:4510-4559:4510-4559'
121121
environment:
122122
- LOCALSTACK_AUTH_TOKEN=${LOCALSTACK_AUTH_TOKEN:?}
123123
- DEBUG=1
124124
- EXTENSION_AUTO_INSTALL=localstack-extension-mailhog,localstack-extension-httpbin
125125
volumes:
126-
- "./volume:/var/lib/localstack"
127-
- "/var/run/docker.sock:/var/run/docker.sock"
126+
- './volume:/var/lib/localstack'
127+
- '/var/run/docker.sock:/var/run/docker.sock'
128128
```
129129

130130
### Configuration file
@@ -136,33 +136,30 @@ Since LocalStack extensions are essentially just Python pip packages, the `exten
136136

137137
An example project could look something like this:
138138

139-
* `extensions.txt`
139+
- `extensions.txt`
140140

141141
```text
142142
localstack-extension-mailhog
143143
git+https://github.com/localstack/localstack-extensions/#egg=localstack-extension-aws-replicator&subdirectory=aws-replicator
144144
```
145145

146-
* Project layout:
146+
- Project layout:
147147

148-
<FileTree>
149-
- extension-install
150-
- conf.d
151-
- extensions.txt
152-
- docker-compose.yml
153-
</FileTree>
148+
<FileTree>
149+
- extension-install - conf.d - extensions.txt - docker-compose.yml
150+
</FileTree>
154151

155-
* `docker-compose.yaml`
152+
- `docker-compose.yaml`
156153

157-
```yaml showLineNumbers
158-
services:
159-
localstack:
160-
...
161-
volumes:
162-
- "./volume:/var/lib/localstack"
163-
- "conf.d:/etc/localstack/conf.d"
164-
- "/var/run/docker.sock:/var/run/docker.sock"
165-
```
154+
```yaml showLineNumbers
155+
services:
156+
localstack:
157+
...
158+
volumes:
159+
- "./volume:/var/lib/localstack"
160+
- "conf.d:/etc/localstack/conf.d"
161+
- "/var/run/docker.sock:/var/run/docker.sock"
162+
```
166163

167164
When LocalStack starts up, you should see it tries to install the extensions and all their dependencies.
168165

@@ -212,7 +209,7 @@ ModuleNotFoundError: No module named 'flask'
212209

213210
To resolve this, follow these steps:
214211

215-
* Clear the directory mounted to the LocalStack container at `/var/lib/localstack`.
216-
* Pull the `latest` image of LocalStack (`localstack/localstack-pro:latest`).
217-
* Restart the LocalStack container.
218-
* Reinstall any extensions you were using, unless you have `EXTENSION_AUTO_INSTALL` enabled.
212+
- Clear the directory mounted to the LocalStack container at `/var/lib/localstack`.
213+
- Pull the `latest` image of LocalStack (`localstack/localstack-pro:latest`).
214+
- Restart the LocalStack container.
215+
- Reinstall any extensions you were using, unless you have `EXTENSION_AUTO_INSTALL` enabled.

0 commit comments

Comments
 (0)