Skip to content

DOCS (sept 8 launch hotfix): lstk migration guide - #873

Merged
quetzalliwrites merged 7 commits into
mainfrom
docs-97-migration-guide-lstk
Sep 7, 2026
Merged

DOCS (sept 8 launch hotfix): lstk migration guide #873
quetzalliwrites merged 7 commits into
mainfrom
docs-97-migration-guide-lstk

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Peter authored this migration guide for lstk, it's ready for review.

Closes: https://linear.app/localstack/issue/DOC-97/docs-migration-guide-for-legacy-cli-new-lstk

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 18, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0397999
Status: ✅  Deploy successful!
Preview URL: https://16e01779.localstack-docs.pages.dev
Branch Preview URL: https://docs-97-migration-guide-lstk.localstack-docs.pages.dev

View logs

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

@remotesynth I've added it to the current subsection of dev tools for now. (Since we want to update the lstk doc and add a new subsection, we'll need to revise where the migration guide best belongs.

@remotesynth remotesynth left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a few suggestions

Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk-migration.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk-migration.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk-migration.mdx Outdated
Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk-migration.mdx Outdated
Co-authored-by: Brian Rinaldi <brianrinaldi@fastmail.com>
@quetzalliwrites

quetzalliwrites commented Aug 19, 2026

Copy link
Copy Markdown
Collaborator Author

allrighty @peter-smith-phd brian already left his review, so I incorporated his suggestions into your PR already

right now, it looks like there's just one last feedback comment for you :)

@peter-smith-phd

Copy link
Copy Markdown
Contributor

Given that I wrote this, I won't provide any addition review feedback.

But, I did notice that it's not showing up in the preview pages. How would the users find this page?

image

Replace the separate Homebrew/npm code blocks with a Tabs component,
matching the pattern used elsewhere in the lstk docs, per review
feedback.
@quetzalliwrites

quetzalliwrites commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator Author

Pushed 0e8fd4f9 converting the Homebrew/npm install commands to a Tabs component, per Brian's suggestion.

Now checking Peter's concern about the page not showing in nav....

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Given that I wrote this, I won't provide any addition review feedback.

But, I did notice that it's not showing up in the preview pages. How would the users find this page?

image

It's not showing up because you didn't update the astro config js @peter-smith-phd

Copy link
Copy Markdown
Contributor

Ummm… just a reminder that I wrote the page in Notion, and somebody else converted it to the localstack-docs format 😛

Register the new lstk migration guide in the Developer Tools >
Running LocalStack section, between the lstk CLI and MCP Server
entries.
@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

You asked why it wasn't showing up, I understood your question to be about not understanding how it works ;) @peter-smith-phd

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

@remotesynth do you want to add anything? otherwise, can you approve the PR to remove merging blocker?

This looks good to merge tmw if agreed.

@quetzalliwrites
quetzalliwrites requested review from peter-smith-phd and removed request for peter-smith-phd August 25, 2026 19:10
@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Heads up, pinging you here too @mmaureenliu in case you'd like to review now that you're back tmw.

Copy link
Copy Markdown
Contributor

I definitely understand how it works, but I recommend you say "It's not showing up because the astro config js wasn't updated correctly" or "thanks for pointing that out, I'll fix it", rather than indicating that it was me that missed it in the first place. Just a different language choice.

@mmaureenliu mmaureenliu left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A really well-written doc. Thanks @peter-smith-phd and all who contributed!

I made some very minor comments.

I also asked Jacque to take a look at the preview in case she has any feedbacks.

Comment thread src/content/docs/aws/developer-tools/running-localstack/lstk-migration.mdx Outdated
- Clarify that plain `lstk`/`lstk start` triggers the browser login
  automatically; `lstk login` is only needed to authenticate ahead of
  time or switch accounts.
- Link each unsupported-feature name in the "Unsupported features"
  table to its docs page, and link the GitHub Action row to the
  setup-localstack repo, so readers can follow up for detail as the
  intro paragraph already promises.
@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Thanks @mmaureenliu — pushed 5664f54f addressing both:

  • Clarified that plain lstk/lstk start triggers the browser login automatically; lstk login is only needed to authenticate ahead of time or switch accounts.
  • Linked each unsupported-feature name in the "Unsupported features" table to its docs page, and linked the GitHub Action row to the setup-localstack repo, so readers can actually follow up for detail as the intro paragraph promises.

@quetzalliwrites quetzalliwrites changed the title DOCS: lstk migration guide DOCS (sept 8 launch hotfix): lstk migration guide Sep 7, 2026
This guide was written before the lstk docs were split into the
nine-page running-localstack/lstk/ directory (merged in #898). Move
it from the flat lstk-migration.mdx file into that directory as
migration.mdx, and nest it in the sidebar's "lstk CLI" group instead
of as a sibling entry, positioned right before FAQ & Troubleshooting.

Drop the now-meaningless sidebar.order frontmatter field: this
section uses an explicit sidebar array (order controlled by array
position), not autogenerate, matching the other eight pages in the
directory.
@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Update: merged latest main into this branch (bringing in the lstk v2 IA split from #898, plus everything else merged since) and moved this migration guide to live inside that new structure instead of as a flat sibling file.

  • lstk-migration.mdxlstk/migration.mdx, nested in the sidebar's "lstk CLI" group instead of as a top-level sibling entry.
  • Positioned it right before FAQ & Troubleshooting, so the nav order is now: Overview → Authentication → Configuration → Lifecycle Commands → Cloud & IaC Commands → Snapshots → Automation & CI → Setup & Maintenance → Migration Guide → FAQ & Troubleshooting.
  • Dropped the now-meaningless sidebar.order frontmatter field — this section uses an explicit sidebar array, not autogenerate, so order is controlled by array position like the other eight pages.
  • Confirmed no other file in the repo referenced the old flat path, and this page never shipped to main, so no redirect is needed.
  • Verified with a full npx astro build (417 pages, all internal links valid) and confirmed the rendered nav order matches directly against the built HTML.

Didn't want this content-location mismatch to fall through the cracks now that the lstk docs have a real home. Pushed as 03979995.

@quetzalliwrites
quetzalliwrites merged commit 4131885 into main Sep 7, 2026
1 check passed
@quetzalliwrites
quetzalliwrites deleted the docs-97-migration-guide-lstk branch September 7, 2026 08:09
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.

4 participants