Skip to content

docs: consolidate sandbox docs under /sandboxes and add redirects#445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sophiajwitt merged 2 commits into from
Aug 4, 2026
Merged

docs: consolidate sandbox docs under /sandboxes and add redirects #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6184226
docs: redirect /sandboxes/quickstart to /sandboxes/getting-started
Aug 4, 2026
e564016
docs: consolidate all sandbox docs under /sandboxes prefix
Aug 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions mint.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -138,19 +138,19 @@
{
"group": "Python",
"pages": [
"sandbox/sdk/python/quickstart",
"sandbox/sdk/python/volumes",
"sandbox/sdk/python/reference",
"sandbox/sdk/python/errors"
"sandboxes/sdk/python/quickstart",
"sandboxes/sdk/python/volumes",
"sandboxes/sdk/python/reference",
"sandboxes/sdk/python/errors"
]
},
{
"group": "TypeScript",
"pages": [
"sandbox/sdk/typescript/quickstart",
"sandbox/sdk/typescript/volumes",
"sandbox/sdk/typescript/reference",
"sandbox/sdk/typescript/errors"
"sandboxes/sdk/typescript/quickstart",
"sandboxes/sdk/typescript/volumes",
"sandboxes/sdk/typescript/reference",
"sandboxes/sdk/typescript/errors"
]
}
]
Expand DownExpand Up@@ -273,7 +273,22 @@
{ "source": "/provision/changing-instance-types", "destination": "/cloud-accounts/node-groups" },
{ "source": "/cli/v1-and-v2", "destination": "/cli/basic-usage" },
{ "source": "/guides/fastapi/deploy-fastapi", "destination": "/applications/deploy/deploy-from-github-repo" },
{ "source": "/docs/advanced-nginx-settings", "destination": "/applications/configure/advanced-networking" }
{ "source": "/docs/advanced-nginx-settings", "destination": "/applications/configure/advanced-networking" },
{ "source": "/sandboxes/quickstart", "destination": "/sandboxes/getting-started" },
{ "source": "/sandbox/quickstart", "destination": "/sandboxes/getting-started" },
{ "source": "/sandbox/overview", "destination": "/sandboxes/overview" },
{ "source": "/sandbox/getting-started", "destination": "/sandboxes/getting-started" },
{ "source": "/sandbox/networking", "destination": "/sandboxes/networking" },
{ "source": "/sandbox/capacity", "destination": "/sandboxes/capacity" },
{ "source": "/sandbox/cli", "destination": "/sandboxes/cli" },
{ "source": "/sandbox/sdk/python/quickstart", "destination": "/sandboxes/sdk/python/quickstart" },
{ "source": "/sandbox/sdk/python/volumes", "destination": "/sandboxes/sdk/python/volumes" },
{ "source": "/sandbox/sdk/python/reference", "destination": "/sandboxes/sdk/python/reference" },
{ "source": "/sandbox/sdk/python/errors", "destination": "/sandboxes/sdk/python/errors" },
{ "source": "/sandbox/sdk/typescript/quickstart", "destination": "/sandboxes/sdk/typescript/quickstart" },
{ "source": "/sandbox/sdk/typescript/volumes", "destination": "/sandboxes/sdk/typescript/volumes" },
{ "source": "/sandbox/sdk/typescript/reference", "destination": "/sandboxes/sdk/typescript/reference" },
{ "source": "/sandbox/sdk/typescript/errors", "destination": "/sandboxes/sdk/typescript/errors" }
],
"footerSocials": {
"twitter": "https://twitter.com/porterdotrun"
Expand Down
4 changes: 2 additions & 2 deletions sandboxes/cli.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -466,5 +466,5 @@ porter sandbox volume delete my-data

- [Sandboxes Overview](/sandboxes/overview)
- [Sandboxes Getting Started](/sandboxes/getting-started)
- [Python Sandbox SDK quickstart](/sandbox/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandbox/sdk/typescript/quickstart)
- [Python Sandbox SDK quickstart](/sandboxes/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandboxes/sdk/typescript/quickstart)
4 changes: 2 additions & 2 deletions sandboxes/getting-started.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -321,5 +321,5 @@ sandbox = porter.sandboxes.create(

- Use [Sandbox Networking](/sandboxes/networking) to serve sandboxes over HTTPS on your own domains.
- Use [the sandbox CLI guide](/sandboxes/cli) to list, inspect logs, exec into, and terminate sandboxes.
- Use the [Python Sandbox SDK quickstart](/sandbox/sdk/python/quickstart) for Python services.
- Use the [TypeScript Sandbox SDK quickstart](/sandbox/sdk/typescript/quickstart) for Node.js and TypeScript services.
- Use the [Python Sandbox SDK quickstart](/sandboxes/sdk/python/quickstart) for Python services.
- Use the [TypeScript Sandbox SDK quickstart](/sandboxes/sdk/typescript/quickstart) for Node.js and TypeScript services.
4 changes: 2 additions & 2 deletions sandboxes/networking.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -191,5 +191,5 @@ console.log(`https://${status.host}`);
## Next steps

- [Sandboxes Getting Started](/sandboxes/getting-started)
- [Python Sandbox SDK reference](/sandbox/sdk/python/reference)
- [TypeScript Sandbox SDK reference](/sandbox/sdk/typescript/reference)
- [Python Sandbox SDK reference](/sandboxes/sdk/python/reference)
- [TypeScript Sandbox SDK reference](/sandboxes/sdk/typescript/reference)
12 changes: 6 additions & 6 deletions sandboxes/overview.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,8 +64,8 @@ Names are the canonical way to refer to sandboxes and volumes in the SDK and CLI

Your application creates and manages sandboxes with a Sandbox SDK. For now, we recommend deploying that application as a Porter Application in the same AWS cluster where you want to run sandboxes.

- [Python Sandbox SDK quickstart](/sandbox/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandbox/sdk/typescript/quickstart)
- [Python Sandbox SDK quickstart](/sandboxes/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandboxes/sdk/typescript/quickstart)

## Use the CLI for operations

Expand All@@ -88,13 +88,13 @@ A sandbox that opens a port can be served over HTTPS on a hostname under your ow

Volumes provide persistent storage that can be mounted into sandboxes at launch. Create a volume first, then pass `volume_mounts` when creating a sandbox.

- [Python Sandbox SDK volumes](/sandbox/sdk/python/volumes)
- [TypeScript Sandbox SDK volumes](/sandbox/sdk/typescript/volumes)
- [Python Sandbox SDK volumes](/sandboxes/sdk/python/volumes)
- [TypeScript Sandbox SDK volumes](/sandboxes/sdk/typescript/volumes)
- [Sandbox CLI volume commands](/sandboxes/cli#porter-sandbox-volume)

## Next steps

- [Sandboxes Getting Started](/sandboxes/getting-started)
- [Sandbox Networking](/sandboxes/networking)
- [Python Sandbox SDK quickstart](/sandbox/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandbox/sdk/typescript/quickstart)
- [Python Sandbox SDK quickstart](/sandboxes/sdk/python/quickstart)
- [TypeScript Sandbox SDK quickstart](/sandboxes/sdk/typescript/quickstart)
0 sandbox/sdk/python/errors.mdx → sandboxes/sdk/python/errors.mdx
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions sandbox/sdk/python/quickstart.mdx → sandboxes/sdk/python/quickstart.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,7 +137,7 @@ async with AsyncPorter() as porter:

## Next steps

- [Python Sandbox SDK reference](/sandbox/sdk/python/reference)
- [Python Sandbox SDK volumes](/sandbox/sdk/python/volumes)
- [Python Sandbox SDK errors](/sandbox/sdk/python/errors)
- [Python Sandbox SDK reference](/sandboxes/sdk/python/reference)
- [Python Sandbox SDK volumes](/sandboxes/sdk/python/volumes)
- [Python Sandbox SDK errors](/sandboxes/sdk/python/errors)
- [Sandboxes getting started](/sandboxes/getting-started)
4 changes: 2 additions & 2 deletions sandbox/sdk/python/reference.mdx → sandboxes/sdk/python/reference.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -192,5 +192,5 @@ Use these only when you need an endpoint that is not wrapped by the ergonomic SD

## Next steps

- [Python Sandbox SDK volumes](/sandbox/sdk/python/volumes)
- [Python Sandbox SDK errors](/sandbox/sdk/python/errors)
- [Python Sandbox SDK volumes](/sandboxes/sdk/python/volumes)
- [Python Sandbox SDK errors](/sandboxes/sdk/python/errors)
6 changes: 3 additions & 3 deletions sandbox/sdk/python/volumes.mdx → sandboxes/sdk/python/volumes.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -176,6 +176,6 @@ async with AsyncPorter() as porter:

## Next steps

- [Python Sandbox SDK quickstart](/sandbox/sdk/python/quickstart)
- [Python Sandbox SDK reference](/sandbox/sdk/python/reference)
- [Python Sandbox SDK errors](/sandbox/sdk/python/errors)
- [Python Sandbox SDK quickstart](/sandboxes/sdk/python/quickstart)
- [Python Sandbox SDK reference](/sandboxes/sdk/python/reference)
- [Python Sandbox SDK errors](/sandboxes/sdk/python/errors)
0 sandbox/sdk/typescript/errors.mdx → sandboxes/sdk/typescript/errors.mdx
View file
Open in desktop
File renamed without changes.
6 changes: 3 additions & 3 deletions sandbox/sdk/typescript/quickstart.mdx → sandboxes/sdk/typescript/quickstart.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -123,7 +123,7 @@ const sandboxes = await Promise.all(

## Next steps

- [TypeScript Sandbox SDK reference](/sandbox/sdk/typescript/reference)
- [TypeScript Sandbox SDK volumes](/sandbox/sdk/typescript/volumes)
- [TypeScript Sandbox SDK errors](/sandbox/sdk/typescript/errors)
- [TypeScript Sandbox SDK reference](/sandboxes/sdk/typescript/reference)
- [TypeScript Sandbox SDK volumes](/sandboxes/sdk/typescript/volumes)
- [TypeScript Sandbox SDK errors](/sandboxes/sdk/typescript/errors)
- [Sandboxes getting started](/sandboxes/getting-started)
4 changes: 2 additions & 2 deletions sandbox/sdk/typescript/reference.mdx → sandboxes/sdk/typescript/reference.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -186,5 +186,5 @@ Use these only when you need an endpoint that is not wrapped by the ergonomic SD

## Next steps

- [TypeScript Sandbox SDK volumes](/sandbox/sdk/typescript/volumes)
- [TypeScript Sandbox SDK errors](/sandbox/sdk/typescript/errors)
- [TypeScript Sandbox SDK volumes](/sandboxes/sdk/typescript/volumes)
- [TypeScript Sandbox SDK errors](/sandboxes/sdk/typescript/errors)
6 changes: 3 additions & 3 deletions sandbox/sdk/typescript/volumes.mdx → sandboxes/sdk/typescript/volumes.mdx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -184,6 +184,6 @@ Deleting a volume fails while it is attached to a sandbox. Terminate any attache

## Next steps

- [TypeScript Sandbox SDK quickstart](/sandbox/sdk/typescript/quickstart)
- [TypeScript Sandbox SDK reference](/sandbox/sdk/typescript/reference)
- [TypeScript Sandbox SDK errors](/sandbox/sdk/typescript/errors)
- [TypeScript Sandbox SDK quickstart](/sandboxes/sdk/typescript/quickstart)
- [TypeScript Sandbox SDK reference](/sandboxes/sdk/typescript/reference)
- [TypeScript Sandbox SDK errors](/sandboxes/sdk/typescript/errors)