Skip to content

DOC-339: Rewrite Snowflake Getting Started to mirror AWS v2 and default to lstk - #878

Draft
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-339-docs-snowflake-getting-started-v2-also-making-lstk-default
Draft

DOC-339: Rewrite Snowflake Getting Started to mirror AWS v2 and default to lstk#878
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-339-docs-snowflake-getting-started-v2-also-making-lstk-default

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Summary

Mirrors the AWS Getting Started rewrite (DOC-12, #606) information architecture for Snowflake: Overview, Installation, Local Development, CI Integration, AI & Agent Workflows, Auth Token, FAQ.

  • Overview and Installation are split into separate pages (previously combined into one file titled "Installation" with no landing page). Overview is a new SectionCards landing page; Installation leads with lstk (lstk start --type snowflake), with Docker Compose/CLI as secondary paths.
  • Quickstart is decoupled and removed. Its content is folded into a new Local Development page with an explicit, unbroken walkthrough: start the emulator via lstk → connect the Snowflake CLI to a localstack connection profile → run a first query → inspect results in the Web App → clean up. Adds a 301 redirect from the old quickstart URL.
  • CI Integration is a new page with lstk-based CI snippets.
  • AI & Agent Workflows is a new top-level page centered on the MCP server's localstack-snowflake-client tool.
  • Auth Token and FAQ are restructured to match the AWS pattern while keeping Snowflake-specific content (session verify endpoint, SQL API/hostname/image-tag FAQs) that has no AWS equivalent.
  • Fixed three tutorial pages whose prerequisite links pointed at the now-split /snowflake/getting-started/ page.

Where this deliberately doesn't mirror AWS 1:1

  • No lstk wrapper for the Snowflake CLI. Agents/users run snow directly against its own localstack connection profile — there's no lstk snow proxy the way there's lstk aws/lstk terraform/lstk cdk.
  • No per-provider CI guide fan-out. AWS links to dedicated /aws/ci-pipelines/<provider>/ pages; Snowflake only has one consolidated CI page, so CI Integration links there instead of inventing pages that don't exist.
  • No claim about Snowflake-specific LocalStack Skills coverage — couldn't verify one way or the other, so the AI & Agent Workflows page omits that bullet rather than guessing.
  • Did not reuse AWS's LocalStack/setup-localstack@main GitHub Action example for the CI snippets, since its Snowflake support is unverified; used a plain lstk-based step instead.

Linear: https://linear.app/localstack/issue/DOC-339/docs-snowflake-getting-started-v2-also-making-lstk-default-cli

Test plan

  • astro build completes successfully (403 pages)
  • starlight-links-validator reports all internal links valid
  • No "Quickstart" naming remains anywhere in the Snowflake Getting Started section
  • All CLI examples in the 7 nav pages use lstk
  • Nav titles/order verified: Overview(1), Installation(2), Local Development(3), CI Integration(4), AI & Agent Workflows(5), Auth Token(6), FAQ(7)

…lt to lstk

Mirrors the AWS Getting Started rewrite (DOC-12) information architecture:
Overview, Installation, Local Development, CI Integration, AI & Agent
Workflows, Auth Token, FAQ.

- Overview and Installation are split into separate pages; Overview
  is a new SectionCards landing page, Installation leads with lstk
  (lstk start --type snowflake), with Docker Compose/CLI as secondary
  paths.
- Quickstart is decoupled and removed; its content is folded into a
  new Local Development page with an explicit, unbroken walkthrough:
  start the emulator via lstk, connect the Snowflake CLI to a
  `localstack` connection profile, run a first query, inspect results
  in the Web App, then clean up. Adds a redirect from the old
  quickstart URL.
- CI Integration is a new page with lstk-based CI snippets, and AI &
  Agent Workflows is a new top-level page centered on the MCP
  server's localstack-snowflake-client tool.
- Auth Token and FAQ are restructured to match the AWS pattern while
  keeping Snowflake-specific content (session verify endpoint, SQL
  API/hostname/image-tag FAQs) that has no AWS equivalent.
- Fixed three tutorial pages whose prerequisite links pointed at the
  now-split /snowflake/getting-started/ page.

Deviates from a literal AWS mirror where the underlying product
differs: no lstk wrapper for the Snowflake CLI (agents run `snow`
directly against its own connection profile), no per-provider CI
guide fan-out (links to the existing consolidated CI integration
page instead), and no claim about Snowflake-specific LocalStack
Skills coverage since it could not be verified.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: fe933b3
Status: ✅  Deploy successful!
Preview URL: https://b741887b.localstack-docs.pages.dev
Branch Preview URL: https://doc-339-docs-snowflake-getti.localstack-docs.pages.dev

View logs

@quetzalliwrites quetzalliwrites self-assigned this Aug 20, 2026
@quetzalliwrites
quetzalliwrites marked this pull request as draft August 20, 2026 11:35
@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

Moving this to draft mode, still want to test and refine it further before going to review round.

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