DOC-430: Create Snowflake lstk doc + rename Tooling to Developer Tools - #910
DOC-430: Create Snowflake lstk doc + rename Tooling to Developer Tools#910quetzalliwrites wants to merge 4 commits into
Conversation
Follows the same v2 lstk IA split done for AWS (#898) and Azure (#909). Unlike Azure, Snowflake never had its own lstk reference at all -- its docs just linked out to the AWS-hosted page. Adds the same nine-page split under /snowflake/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 Snowflake-specific adjustments: - Prerequisites and FAQ links point at Snowflake's own Auth Token, Getting Started, and Help & Support pages where those exist (managing-your-license, the Docker Compose alternative, and get-help). Left the corporate-proxy FAQ link and the legacy LocalStack CLI deprecation tip pointing at the shared AWS pages, since Snowflake has no equivalent of the former and does share the latter (the legacy CLI was cross-product, just deprecated in favor of lstk). - The Volume mounts example already used a Snowflake init hook and type = "snowflake" in the AWS canonical version, so no change was needed there. Also renames snowflake/tooling/ to snowflake/developer-tools/ (moving user-interface.md) and updates the sidebar label from "Tooling" to "Developer Tools", matching the AWS/Azure naming convention per the ticket. Adds a public/_redirects entry for the old /snowflake/tooling/user-interface/ URL, and updates the three existing cross-references to it plus the one snowflake doc that linked out to the AWS-hosted lstk page.
Deploying localstack-docs with
|
| Latest commit: |
354117a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d8c91bfb.localstack-docs.pages.dev |
| Branch Preview URL: | https://doc-430-docs-update-snowflak.localstack-docs.pages.dev |
|
same thoughts as I shared in #909... Hey @remotesynth, Maureen approved the new v2 IA for Now that we've merged that v2 IA for the aws product line, we should make this update for the snow product line docs too. |
Mirrors the same fix agreed on the AWS docs sync PR (#912): Global options apply to everyday interactive use, not just automation/CI, so move the table from automation.mdx to index.mdx, right after Quick start, keeping the detailed sections (Structured output) on automation.mdx with an absolute-path cross-reference.
…-on-new-lstk-v2-ia # Conflicts: # src/content/docs/snowflake/getting-started/quickstart.md
mmaureenliu
left a comment
There was a problem hiding this comment.
I skim read most and suggested changes in three categories:
- the only place that really requires change is the first FAQ as the answer has changed fundamentally.
- I would prefer if all config examples refer to snowflake rather than aws (hopefully my comments have caught them all but worth asking claude to have a once over)
- final bucket is left to your discretion: how much do we prune/change the parts not relevant to snowflake - I'm happy to go with your decision
Config examples now show snowflake instead of aws throughout
configuration.mdx and faq-and-troubleshooting.md, per Maureen's
request to prefer snowflake-relevant examples. Also:
- configuration.mdx: swap ENFORCE_IAM (not applicable to Snowflake)
for SF_LOG = "debug" in the env-profile example, and drop the
fabricated [env.ci] profile ("can't find a realistic CI config for
snowflake").
- lifecycle-commands.md: drop the "Auto-loading a snapshot on start"
subsection (AWS-only end to end; link the config field reference to
the AWS docs instead), use Snowflake-flavored `status` output
examples, and add the start/status --json notes that were missing.
- setup-and-maintenance.md: note that there's no `setup snowflake`
subcommand and why (Snowflake manages its own connection profiles),
linking to /snowflake/integrations/.
- automation.mdx / index.mdx: port the "Targeting an external
emulator" section and --endpoint-url support that Snowflake's docs
never got (this PR predates that addition), since the corrected
Docker Compose FAQ answer needs it to link to something real.
- faq-and-troubleshooting.md: fix the Docker Compose answer (the one
Maureen flagged as fundamentally changed), plus bring Port 443 and
Docker-not-running up to the same corrected wording already in the
AWS/Azure docs, since they had the same pre-#912 staleness.
Verified: full build, all 28 lstk/<page>/#anchor cross-references
resolve in the built output, no em dashes introduced.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Thanks for the thorough pass, @mmaureenliu! Pushed a commit addressing everything: Config examples → snowflake: fixed the two you flagged in
On hiding the snapshot auto-load section ( On the
FAQ examples: all three flagged One thing the Docker Compose fix surfaced: this PR predates the While I was in there I also brought Port 443 and Docker-not-running up to the same wording AWS/Azure already have. They had the same pre-#912 staleness as Docker Compose, just not called out specifically. |
Summary
Follows the same v2 lstk IA split done for AWS (#898) and Azure (#909). Unlike Azure, Snowflake never had its own lstk reference at all — its docs just linked out to the AWS-hosted page. This adds the same nine-page split under
/snowflake/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.mdSnowflake-specific adjustments:
#managing-your-license, the Docker Compose alternative, andget-help).lstk).type = "snowflake"in the AWS canonical version, so no change was needed there.Also, per the ticket:
snowflake/tooling/tosnowflake/developer-tools/(movinguser-interface.md) and updated the sidebar label from "Tooling" to "Developer Tools", matching the AWS/Azure naming convention.public/_redirectsentry for the old/snowflake/tooling/user-interface/URL.Linear ticket
https://linear.app/localstack/issue/DOC-430/docs-update-snowflake-lstk-doc-based-on-new-lstk-v2-ia
Test plan
npx astro buildcompletes successfully (422 pages built)lstk/<page>/#anchorcross-references between the nine new pages resolve to a real heading ID in the built outputgetting-started/auth-token/#managing-your-license,getting-started/#alternatives,help-support/get-help/)user-interfacepage builds at its new path