Skip to content

DOC-361: Migrate localstack CLI refs to lstk in Azure docs#803

Open
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-361-migrate-all-localstack-cli-refs-to-lstk-in-azure-docs
Open

DOC-361: Migrate localstack CLI refs to lstk in Azure docs#803
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-361-migrate-all-localstack-cli-refs-to-lstk-in-azure-docs

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Summary

  • Replace azlocal start-interception/stop-interception with lstk az start-interception/lstk az stop-interception across all 40 Azure service pages that use the interception workflow.
  • Rewrite integrations/az.md to the lstk az pattern (lstk setup azure once, then prefix az commands with lstk az), matching the getting-started quickstart already updated in DOC-360.
  • integrations/python.md: left azlocal's Python SDK (PythonLocalSdk) as-is since lstk has no Python SDK equivalent, but added a note explaining the discrepancy with the az CLI examples elsewhere.
  • integrations/azd.md: left untouched — azdlocal (the azd/Bicep wrapper) isn't something lstk proxies at all.
  • Getting Started docs are out of scope here (handled separately in DOC-360 / DOC-360: Update Azure getting started guide to use lstk #802).

Linear: https://linear.app/localstack/issue/DOC-361/migrate-all-localstack-cli-refs-to-lstk-in-azure-docs

Test plan

  • astro build completes successfully
  • starlight-links-validator reports all internal links valid
  • Confirmed no remaining azlocal/localstack CLI refs outside the two intentionally-excluded files

Replace azlocal's start-interception/stop-interception commands with
lstk az across the Azure service pages and the az integration guide.
azdlocal (azd.md) and azlocal's Python SDK (python.md) are left as-is
since lstk has no equivalent for either.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fffaf25
Status: ✅  Deploy successful!
Preview URL: https://b4169f1b.localstack-docs.pages.dev
Branch Preview URL: https://doc-361-migrate-all-localsta.localstack-docs.pages.dev

View logs

@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.

Only one real change needed: similar to my comment on the quickstart, the az CLI doc should use the start/stop-interception as preferred mode.

I also notice there's still some lingering azlocal and azdlocal and have asked the team about them.

@@ -16,58 +16,33 @@ This guide will show you how to use it to interact with LocalStack.
This guide is designed for users who are new to LocalStack for Azure emulator and assumes basic knowledge of how the Azure CLI works.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Similar to my comments on the Quick Start, we recommend start/stop-interception first, and use the other mode as alternative.

lstk az start-interception
```

:::note

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think this note can be removed now. It served some historical clarification but is now actually more confusing.

lstk az start-interception
```

:::note

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Similarly I think this note can be removed. These notes were probably added to some of the earliest services when the preferred mode was switched.

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.

2 participants