Skip to content

Revamp Snapshots section: major restructuring (largely by hand), and support for lstk - #800

Open
peter-smith-phd wants to merge 20 commits into
doc-312-aws-docs-to-use-lstkfrom
pro-275-rewrite-snapshots-section
Open

Revamp Snapshots section: major restructuring (largely by hand), and support for lstk#800
peter-smith-phd wants to merge 20 commits into
doc-312-aws-docs-to-use-lstkfrom
pro-275-rewrite-snapshots-section

Conversation

@peter-smith-phd

@peter-smith-phd peter-smith-phd commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Migrate the entire "Snapshots" section to use lstk, and perform major restructuring on the existing content.

The Snapshots section had grown organically around Cloud Pods and the legacy localstack CLI. Content had been added over time, in a way that didn't make sense to many readers I talked with. In addition to migrating to lstk, we needed to rethink how the content was structured, making it far easier for novice readers to understand the important concepts.

This change restructures the section around the user's actual goal — where do I want to put my snapshot? — and moves every example to lstk.

Note that most of this work was done by Peter, using AI as an assistant. I reviewed all the content, made conscious decisions about how it should be restructured, and wrote many of the paragraphs myself. In many cases it was easier to write it myself, than to instruct Claude on what should have been written. In the end, Claude was great for testing examples and sanity-testing my grammar.

What changed

Page structure — one page per destination, ordered as a reading path:

Page Purpose
Overview What snapshots are and why they help
Saving snapshots locally Save/load a snapshot file on disk
Saving snapshots to Cloud Pods Share snapshots via the LocalStack platform
Saving snapshots to S3 Save to your own bucket (data-sovereignty cases)
Merging snapshots Merge strategies, extracted to their own page
Persistence Automatic snapshotting for durability
Service coverage Compatibility rules and per-service support

Removed cli-commands.md (now covered by the lstk CLI guide), launchpad.md (no longer works), and export-import-state.md (replaced by "saving locally").

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 20, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 78ca32f
Status: ✅  Deploy successful!
Preview URL: https://1b88df15.localstack-docs.pages.dev
Branch Preview URL: https://pro-275-rewrite-snapshots-se.localstack-docs.pages.dev

View logs

@peter-smith-phd
peter-smith-phd changed the base branch from main to doc-312-aws-docs-to-use-lstk July 20, 2026 22:46
@peter-smith-phd
peter-smith-phd force-pushed the doc-312-aws-docs-to-use-lstk branch from 3d31485 to b0fb87d Compare July 23, 2026 21:55
@peter-smith-phd
peter-smith-phd force-pushed the pro-275-rewrite-snapshots-section branch from e508757 to 9caeb99 Compare July 23, 2026 22:26
@peter-smith-phd peter-smith-phd changed the title Revamp Snapshots section: overview cards, page restructuring, lstk CLI Revamp Snapshots section: major restructuring (largely by hand), and support for lstk Jul 26, 2026
peter-smith-phd and others added 12 commits July 31, 2026 10:44
…o other pages yet.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…itch documented commands to the lstk CLI

Move the Remotes section from cloud-pods.mdx into other-snapshot-storage-options.md, and the (now Snapshot Merging) section into save-snapshots-locally.md. Update save-snapshots-locally.md to document the lstk snapshot save/load commands instead of the legacy localstack CLI, and fix inbound links to the relocated sections across the docs.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Work in progress towards rewriting cloud-pods.mdx around the lstk CLI's snapshot commands instead of the legacy localstack pod CLI, plus a new workflow diagram and a remotes miscellaneous note. Not yet complete (contains a TBD placeholder).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Renames several cloud-pods.mdx headings to better distinguish the Cloud
Pod (the repository) from the snapshot (the saved emulator state), fixes
the one cross-doc link that referenced the old heading anchor, and cleans
up assorted grammar/typo/consistency issues found in a pass over the page
(subject-verb agreement, singular/plural Cloud Pod references, a broken
image markdown tag, a directory-name typo, and stale export/import
wording left over after the heading renames).
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Delete launchpad.md and its images, drop the dead card link from the
Snapshots overview, and repoint legacy launchpad redirects to the
Snapshots overview page instead of the now-removed page.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@peter-smith-phd
peter-smith-phd force-pushed the pro-275-rewrite-snapshots-section branch from 48c85bf to 39fb0fa Compare July 30, 2026 22:45
peter-smith-phd and others added 8 commits August 4, 2026 13:10
Rebuild the "Using the lstk CLI" section around a single worked example
that builds a Cloud Pod over three versions, adding one service at a
time (S3, then SQS, then SNS). Document the `snapshot versions` command
and loading a specific version with the `:<version>` suffix.

All command output in the section is captured from a real run against a
fresh emulator, with the LocalStack version normalised to 2026.8.0.

Also remove the End-to-End Encryption section, which is no longer part
of this page.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@peter-smith-phd
peter-smith-phd marked this pull request as ready for review August 4, 2026 23:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant