Skip to content

DOC-429: Split Azure lstk doc into the same v2 multi-page IA - #909

Open
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-429-docs-update-azure-lstk-doc-based-on-new-lstk-v2-ia
Open

DOC-429: Split Azure lstk doc into the same v2 multi-page IA#909
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-429-docs-update-azure-lstk-doc-based-on-new-lstk-v2-ia

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Summary

Follows up on #898 (the AWS lstk docs split). azure/developer-tools/lstk.mdx turned out to be a 1556-line near-duplicate of the pre-split AWS content — same commands, config reference, and troubleshooting, since lstk is one CLI shared across products. This replaces it with the same nine-page structure, cross-linked under /azure/developer-tools/lstk/:

  • index.mdx, authentication.md, configuration.mdx, lifecycle-commands.md, cloud-and-iac-commands.md, snapshots.md, automation.mdx, setup-and-maintenance.md, faq-and-troubleshooting.md

Azure-specific differences preserved from the original doc (not just a mechanical copy of the AWS content):

  • Prerequisites link to the license section of Azure's own Auth Token guide.
  • Dropped the "legacy LocalStack CLI is deprecated" tip — Azure never had a legacy CLI to migrate from.
  • The Volume mounts example uses a generic init script and type = "azure" instead of AWS's Snowflake-specific example.
  • The Docker Compose FAQ answer links to Azure's own installation guide.
  • Left the corporate-proxy FAQ and Get Help links pointing at the shared AWS pages, since Azure has no equivalent of either and the original doc already did the same.

Also converted Azure's sidebar "Developer Tools" entry from autogenerate to an explicit array (mirroring AWS's approach) so the nine pages get the same nested "lstk CLI" group, labels, and order rather than relying on autogenerate's folder-naming heuristics.

Linear ticket

https://linear.app/localstack/issue/DOC-429/docs-update-azure-lstk-doc-based-on-new-lstk-v2-ia

Test plan

  • npx astro build completes successfully (421 pages built)
  • Link validator confirms all internal links are valid
  • Scripted verification that all 22 lstk/<page>/#anchor cross-references between the nine new Azure pages resolve to a real heading ID in the built output
  • Confirmed no other file in the repo linked to the old /azure/developer-tools/lstk/ single-page anchors, so no redirect or cross-reference sweep is needed

Mirrors the AWS lstk split (#898). The old azure/developer-tools/
lstk.mdx was a 1556-line near-duplicate of the pre-split AWS content
(same commands, config, and reference material, since lstk is one
CLI shared across products). Replaces it with the same nine pages,
cross-linked under /azure/developer-tools/lstk/ instead of
/aws/developer-tools/running-localstack/lstk/:

- index.mdx, authentication.md, configuration.mdx,
  lifecycle-commands.md, cloud-and-iac-commands.md, snapshots.md,
  automation.mdx, setup-and-maintenance.md,
  faq-and-troubleshooting.md

Azure-specific adjustments kept from the original doc rather than
copied verbatim from AWS:
- Prerequisites link to the license section of Azure's own Auth
  Token guide instead of AWS's.
- Dropped the "legacy LocalStack CLI is deprecated" tip, since Azure
  never had a legacy CLI to migrate from.
- The Volume mounts example uses a generic init script and
  type = "azure" instead of the AWS version's Snowflake-specific
  example.
- The Docker Compose FAQ answer links to Azure's own installation
  guide instead of AWS's.
- Left the corporate-proxy FAQ and Get Help links pointing at the
  shared AWS pages, since Azure has no equivalent of either and the
  original doc already did the same.

Converted the sidebar's Developer Tools entry for Azure from
autogenerate to an explicit array (mirroring AWS's structure) so the
nine pages get the same nested "lstk CLI" group, labels, and order
instead of relying on autogenerate's folder-naming heuristics.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 066ee12
Status: ✅  Deploy successful!
Preview URL: https://5661a577.localstack-docs.pages.dev
Branch Preview URL: https://doc-429-docs-update-azure-ls.localstack-docs.pages.dev

View logs

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Hey @remotesynth, Maureen approved the new v2 IA for lstk doc, it's already merged in aws product line docs:

Now that we've merged that v2 IA for the aws product line, we should make this update for the azure product line docs too. Since we're not using components after all.... then we're maintaining in each product line? Or let me know if you have another better idea.

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