Skip to content

DOC-428(sept 8 launch hotfix): Update remainder of Snowflake docs to push lstk - #908

Merged
quetzalliwrites merged 5 commits into
mainfrom
doc-428-docs-update-remainder-of-snow-docs-for-pushing-lstk
Sep 7, 2026
Merged

DOC-428(sept 8 launch hotfix): Update remainder of Snowflake docs to push lstk#908
quetzalliwrites merged 5 commits into
mainfrom
doc-428-docs-update-remainder-of-snow-docs-for-pushing-lstk

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Summary

Follows the same lstk migration already done for AWS/Azure docs, and for Snowflake Getting Started in #878. This covers everything else under /snowflake/ that still referenced the legacy localstack CLI (scoped by grepping the whole tree for localstack start/--stack snowflake/`localstack` CLI and excluding getting-started/, which #878 already owns):

  • capabilities/configuration.md: rewrote the env var intro and the "CLI" section to match aws/customization/configuration-options.md's already-established pattern (LOCALSTACK_-prefixed env vars, .lstk/config.toml env profiles, cross-link to the lstk config reference). Dropped the "Profiles" section entirely — CONFIG_PROFILE/*.env files have no lstk equivalent, which is exactly why the AWS docs already dropped this section rather than translating it. Folded LOCALSTACK_VOLUME_DIR into the Docker table, again matching AWS.
  • capabilities/init-hooks.mdx: replaced the "CLI" tab with the lstk .lstk/config.toml volumes pattern, matching aws/customization/advanced/initialization-hooks.mdx.
  • capabilities/state-management.mdx: PERSISTENCE=1 localstack startlstk start --persist; localstack state export/importlstk snapshot save/load, matching the AWS persistence and snapshots docs.
  • tooling/user-interface.md and the three tutorials: swapped the `localstack` CLI prerequisite links and localstack start --stack snowflake invocations for lstk/lstk start --type snowflake, and prefixed forwarded env vars with LOCALSTACK_ where needed (required for lstk start to forward them into the container).

awslocal wrapper usage in the tutorials was left untouched — that's a separate, still-supported wrapper script, not the legacy localstack CLI this ticket targets.

Linear ticket

https://linear.app/localstack/issue/DOC-428/docs-update-remainder-of-snow-docs-for-pushing-lstk

Test plan

  • npx astro build completes successfully (405 pages built)
  • Link validator confirms all internal links are valid
  • Swept the full /snowflake/ tree afterward for any remaining localstack start/--stack snowflake/legacy CLI references outside getting-started/ — none found

Follows the same lstk migration already done for AWS/Azure docs and
for Snowflake Getting Started (#878). Covers everything else under
/snowflake/ that still referenced the legacy `localstack` CLI:

- capabilities/configuration.md: rewrite the env var intro and the
  "CLI" section to match AWS's configuration-options.md pattern
  (LOCALSTACK_-prefixed env vars, .lstk/config.toml env profiles,
  cross-link to the lstk config reference). Drop the "Profiles"
  section entirely (CONFIG_PROFILE/*.env files have no lstk
  equivalent, same as the AWS docs already did) and fold
  LOCALSTACK_VOLUME_DIR into the Docker table.
- capabilities/init-hooks.mdx: replace the CLI tab with the lstk
  .lstk/config.toml `volumes` pattern, matching
  aws/customization/advanced/initialization-hooks.mdx.
- capabilities/state-management.mdx: `PERSISTENCE=1 localstack start`
  -> `lstk start --persist`; `localstack state export/import` ->
  `lstk snapshot save/load`, matching the AWS persistence and
  snapshots docs.
- tooling/user-interface.md and the three tutorials: swap the
  `localstack` CLI prerequisite links and `localstack start --stack
  snowflake` invocations for `lstk`/`lstk start --type snowflake`,
  and prefix forwarded env vars with LOCALSTACK_ where needed.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 1, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4c53506
Status: ✅  Deploy successful!
Preview URL: https://4cb7b995.localstack-docs.pages.dev
Branch Preview URL: https://doc-428-docs-update-remainde.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.

Lgtm. Some minor comments to address but I'll pre-approve.

Comment thread src/content/docs/snowflake/capabilities/configuration.md
Comment thread src/content/docs/snowflake/capabilities/configuration.md
Comment thread src/content/docs/snowflake/capabilities/init-hooks.mdx
Comment thread src/content/docs/snowflake/capabilities/state-management.mdx
Comment thread src/content/docs/snowflake/capabilities/state-management.mdx Outdated
Comment thread src/content/docs/snowflake/capabilities/state-management.mdx Outdated
Comment thread src/content/docs/snowflake/capabilities/state-management.mdx Outdated
Comment thread src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md Outdated
Comment thread src/content/docs/snowflake/tutorials/s3-tables-iceberg-integration.md Outdated
@mmaureenliu

Copy link
Copy Markdown

Actually found a (slightly) bigger problem on Peter's reminder: awslocal is still used in snowpipe.md, glue-catalog.md, storage-integrations.md, stages.mdx, dynamic-tables.md, iceberg-tables.md, polaris-catalog.md, airflow.md, aws-lambda-localstack-snowpark.md, s3-tables-iceberg-integration.md

All should be updated to lstk aws but this could be a simple search & replace fix.

- capabilities/configuration.md: replace the two bash export examples
  for custom Snowflake hostnames with the .lstk/config.toml env
  profile pattern Maureen specified in PRO-327, instead of exporting
  LOCALSTACK_-prefixed env vars inline.
- capabilities/init-hooks.mdx: add an inline comment noting DEBUG is
  optional and only helps diagnose init hook issues, not required.
- capabilities/state-management.mdx: note that resuming a persisted
  session or restarting with persistence on requires passing
  --persist again (lstk start --persist / lstk restart --persist);
  rename the <file-name> placeholder to <path-to-snapshot-file> for
  clarity; link to the lstk snapshot docs for the full list of
  supported save destinations.
- tutorials/credit-scoring-with-localstack-snowpark.md and
  tutorials/s3-tables-iceberg-integration.md: simplify
  `lstk start --type snowflake` to plain `lstk start`.
- Fix the bigger issue Maureen found: awslocal was still used in
  eight feature/integration docs this PR's scope missed (snowpipe,
  glue-catalog, storage-integrations, stages, dynamic-tables,
  iceberg-tables, polaris-catalog, airflow) plus two tutorials
  already touched by this PR. Replaced every awslocal invocation and
  prose reference with lstk aws, matching the pattern already
  established across the AWS docs (`lstk aws <command>`, prereq
  links to /aws/developer-tools/running-localstack/lstk/#aws).
@quetzalliwrites

quetzalliwrites commented Sep 7, 2026

Copy link
Copy Markdown
Collaborator Author

tyvm @mmaureenliu! Pushed fc3bfd04 addressing all 9 review threads, including the "awslocal issue":

  • capabilities/configuration.md: replaced both bash env-var examples for custom Snowflake hostnames with the .lstk/config.toml env profile pattern you specified in PRO-327.
  • capabilities/init-hooks.mdx: added the inline comment noting DEBUG is optional, not required for init hooks.
  • capabilities/state-management.mdx: added the resume/restart-with-persistence note (lstk stop && lstk start --persist / lstk restart --persist), renamed <file-name><path-to-snapshot-file> in both the save and load commands, and linked to the lstk snapshot docs for the full list of save destinations.
  • Both tutorials: simplified lstk start --type snowflakelstk start.
  • The bigger issue: replaced every awslocal invocation and prose reference across snowpipe.md, glue-catalog.md, storage-integrations.md, stages.mdx, dynamic-tables.md, iceberg-tables.md, polaris-catalog.md, airflow.md, and the two tutorials with lstk aws, matching the pattern already established across the AWS docs. Confirmed with a full-tree grep afterward — zero awslocal references remain anywhere under /snowflake/.

…or-pushing-lstk

# Conflicts:
#	src/content/docs/snowflake/features/glue-catalog.md
#	src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md
#	src/content/docs/snowflake/tutorials/s3-tables-iceberg-integration.md
Two links in configuration.md still pointed at the old
/aws/developer-tools/running-localstack/lstk#... single-page anchors,
missed by the merge conflict resolution since this file wasn't part
of the conflicting set. Point them at the post-split
configuration/ subpage, matching the pattern already used in
aws/customization/configuration-options.md.
@quetzalliwrites quetzalliwrites changed the title DOC-428: Update remainder of Snowflake docs to push lstk DOC-428(sept 8 launch hotfix): Update remainder of Snowflake docs to push lstk Sep 7, 2026
…or-pushing-lstk

# Conflicts:
#	src/content/docs/snowflake/tutorials/aws-lambda-localstack-snowpark.md
#	src/content/docs/snowflake/tutorials/credit-scoring-with-localstack-snowpark.md
#	src/content/docs/snowflake/tutorials/s3-tables-iceberg-integration.md
@quetzalliwrites
quetzalliwrites merged commit bd05d83 into main Sep 7, 2026
1 check passed
@quetzalliwrites
quetzalliwrites deleted the doc-428-docs-update-remainder-of-snow-docs-for-pushing-lstk branch September 7, 2026 07:52
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