DOC-339 (sept 8 launch hotfix): Rewrite Snowflake Getting Started to mirror AWS v2 and default to lstk - #878
Conversation
…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.
Deploying localstack-docs with
|
| Latest commit: |
e02fa72
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9190d230.localstack-docs.pages.dev |
| Branch Preview URL: | https://doc-339-docs-snowflake-getti.localstack-docs.pages.dev |
|
Moving this to draft mode, still want to test and refine it further before going to review round. |
Small wording tweaks across Overview, Installation, and AI & Agent Workflows for clarity and consistency.
remotesynth
left a comment
There was a problem hiding this comment.
Note that I did a read of the pages and they look good but I not get to run through the steps to confirm.
mmaureenliu
left a comment
There was a problem hiding this comment.
Thanks for the wonderful work! Mostly looks great to me, with some modifications suggested:
- mainly use
lstk startnotlstk start --type snowflake - I want Peter and Przemek to review some tech content for accuracy
- I assume the AI workflow works, but would appreciate acknowledgement from someone who's tested it (I don't have time to test it in the next few days)
- Mirror the Azure getting-started doc's lstk emulator-selection pattern (interactive picker, no --type flag) instead of recommending `lstk start --type snowflake`, since the team is still debating whether --type should mutate the global config. - Drop the "AWS, Snowflake, and Azure emulators" aside from the lstk description to match the AWS doc's phrasing. - Soften the CI wording in the installation guide's "Container and orchestration tools" intro so it doesn't imply lstk is unsuitable for CI, and cross-link to the CI Integration page. - Point the "configuration" link at the Snowflake-specific configuration page instead of the AWS one. - Reword the Local Development prerequisite from "a valid Auth Token" to "a license that includes Snowflake features" to distinguish token validity from license entitlement. - Put the Snowflake CLI's optional-parameter prompt in a callout box. - Drop the legacy `localstack` CLI comparison from the CI/CD guide. - Fix the credit-scoring Snowpark tutorial's stale `localstack` CLI reference to use `lstk`.
|
DOC-339: Address review feedback on Snowflake Getting Started rewrite
Pushed as A few threads I left open for others, since they need input I can't verify myself:
|
|
tyvm to @mmaureenliu and @peter-smith-phd for the amazing 1st pass review round 👏🏻 |
mmaureenliu
left a comment
There was a problem hiding this comment.
Lgtm. Just wait for @hovaesco to confirm the few tech points remained and I think we are done!
hovaesco
left a comment
There was a problem hiding this comment.
Nice update, but the changes are inconsistent between pages.
| ### Docker Compose | ||
|
|
||
| Use Docker Compose when you want a reusable configuration file that can be shared across a team or checked into a project repository. | ||
| Create a `docker-compose.yml` with the following configuration: |
There was a problem hiding this comment.
The Docker socket config is same as in AWS
|
|
||
| Use the Docker CLI for one-off starts or when you want to test a container configuration before moving it into Compose: | ||
|
|
||
| ```bash |
| <TabItem label="Docker Compose"> | ||
|
|
||
| ```bash | ||
| docker compose logs -f localstack |
There was a problem hiding this comment.
Yes, it's a service name from Docker compose, I would use localstack-snowflake for clarity
- Add the docker socket mount to both the Docker Compose and Docker CLI examples, confirmed needed same as AWS (hovaesco). - Remove the redundant "Update lstk" step right after a fresh install (hovaesco). - Rename the Docker Compose service key to localstack-snowflake for clarity, and update the "View logs" Docker Compose command to match (hovaesco/Maureen). - Add --name localstack-snowflake to the Docker CLI start command: the "docker logs -f localstack-snowflake" example didn't work without it, since no --name was set (hovaesco). - Fix the auth-token guide's lingering `lstk start --type snowflake` to plain `lstk start`, consistent with the installation guide. - Use distinguishable, realistic-looking test credentials in Local Development now that hovaesco confirmed the Python emulator has no format limitation there (Maureen's original suggestion). - Migrate the remaining two tutorials (aws-lambda-localstack-snowpark and s3-tables-iceberg-integration) from the legacy `localstack` CLI to lstk, matching the credit-scoring tutorial fixed earlier and answering hovaesco's "why only one of three" question.
|
Nice review feedback @hovaesco, thx! Please let us know when you've had a chance to also test this. I've pushed
|
hotfix): Rewrite Snowflake Getting Started to mirror AWS v2 and default to lstk
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.
lstk(lstk start --type snowflake), with Docker Compose/CLI as secondary paths.lstk→ connect the Snowflake CLI to alocalstackconnection profile → run a first query → inspect results in the Web App → clean up. Adds a 301 redirect from the old quickstart URL.lstk-based CI snippets.localstack-snowflake-clienttool./snowflake/getting-started/page.Where this deliberately doesn't mirror AWS 1:1
lstkwrapper for the Snowflake CLI. Agents/users runsnowdirectly against its ownlocalstackconnection profile — there's nolstk snowproxy the way there'slstk aws/lstk terraform/lstk cdk./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.LocalStack/setup-localstack@mainGitHub Action example for the CI snippets, since its Snowflake support is unverified; used a plainlstk-based step instead.Linear: https://linear.app/localstack/issue/DOC-339/docs-snowflake-getting-started-v2-also-making-lstk-default-cli
Test plan
astro buildcompletes successfully (403 pages)starlight-links-validatorreports all internal links validlstk