Skip to content

DOC-430: Create Snowflake lstk doc + rename Tooling to Developer Tools - #910

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

DOC-430: Create Snowflake lstk doc + rename Tooling to Developer Tools#910
quetzalliwrites wants to merge 1 commit into
mainfrom
doc-430-docs-update-snowflake-lstk-doc-based-on-new-lstk-v2-ia

Conversation

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

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.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 — 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, per the ticket:

  • Renamed snowflake/tooling/ to snowflake/developer-tools/ (moving user-interface.md) and updated the sidebar label from "Tooling" to "Developer Tools", matching the AWS/Azure naming convention.
  • Added a public/_redirects entry for the old /snowflake/tooling/user-interface/ URL.
  • Updated the three existing cross-references to that page, plus the one Snowflake doc that linked out to the AWS-hosted lstk page (now points at the new Snowflake-local copy).

Linear ticket

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

Test plan

  • npx astro build completes successfully (422 pages built)
  • Link validator confirms all internal links are valid
  • Scripted verification that all 22 lstk/<page>/#anchor cross-references between the nine new pages resolve to a real heading ID in the built output
  • Verified the three Snowflake-specific anchor targets exist (getting-started/auth-token/#managing-your-license, getting-started/#alternatives, help-support/get-help/)
  • Confirmed the redirected user-interface page builds at its new path

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.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8fe95ee
Status: ✅  Deploy successful!
Preview URL: https://69bb4c04.localstack-docs.pages.dev
Branch Preview URL: https://doc-430-docs-update-snowflak.localstack-docs.pages.dev

View logs

@quetzalliwrites

Copy link
Copy Markdown
Collaborator Author

same thoughts as I shared in #909...

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 snow 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