Skip to content

v2 Getting Started (AWS) - #606

Merged
quetzalliwrites merged 59 commits into
mainfrom
revise-getting-started
Jul 17, 2026
Merged

v2 Getting Started (AWS)#606
quetzalliwrites merged 59 commits into
mainfrom
revise-getting-started

Conversation

@remotesynth

@remotesynthremotesynth commented Apr 24, 2026

Copy link
Copy Markdown
Collaborator

The concepts behind this draft:

  1. update cli mentions to feature lstk
  2. decouple the Quickstart from the Getting Started
  3. bring AI and agent use cases up front

DOC-12

The concepts behind this draft:
1. Design paths for the main LocalStack use cases
2. Simplify the quickstart to get them to success faster
3. Have both an awslocal and a terraform quickstart
4. Bring AI and agent use cases up front
[DOC-12](https://linear.app/localstack/issue/DOC-12/docs-quickstart-v2)
@cloudflare-workers-and-pages

cloudflare-workers-and-pagesBot commented Apr 24, 2026

Copy link
Copy Markdown

Deploying localstack-docs with Cloudflare Pages Cloudflare Pages

Latest commit:80382bb
Status: ✅ Deploy successful!
Preview URL:https://be1982b3.localstack-docs.pages.dev
Branch Preview URL:https://revise-getting-started.localstack-docs.pages.dev

View logs

@quetzalliwrites
quetzalliwrites marked this pull request as draft April 27, 2026 12:17
@quetzalliwrites

Copy link
Copy Markdown
Collaborator

added do not merge label + made it a draft to avoid any accidental merges @remotesynth 😸

@peter-smith-phdpeter-smith-phd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sharing this PR. It's really nice to see the focus of Local, CI, and AI, and the working example is the perfect size to get something up and running in 10 minutes.

But, I think there's more trimming to be done. There's still a lot of complexity in these pages that go beyond "Getting Started". It'd suggest you document the happy path for the common case, and just hyperlink to the more advanced pages for more detail. If we can't get the happy path working well, then we need to fix the software to make it work better.

Comment threadsrc/content/docs/aws/getting-started/index.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/index.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/installation.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/installation.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/installation.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/ci-cd.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/ai-workflows.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/index.mdx
Comment threadsrc/content/docs/aws/getting-started/auth-token.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/faq.mdx
Comment threadsrc/content/docs/aws/getting-started/index.mdx Outdated
Comment threadsrc/content/docs/aws/getting-started/index.mdx Outdated
@quetzalliwrites

Copy link
Copy Markdown
Collaborator

PR Audit Summary

Status: Needs Significant Rework

This PR introduces several critical technical inaccuracies, broken code snippets, and information architectural redundancies. To maintain our technical integrity and avoid introducing "docs debt," the following must be addressed before merging.

Technical & Architectural Requirements

1) Technical Accuracy (High Priority)

2) Code Integrity (Blockers):

All code blocks must be validated and "copy-paste ready" before deployment.

3) Documentation Information Architecture (DRY Principles):

4) Editorial Standards:

  • Voice & Tone: The current draft uses informal, "blog-style" phrasing (e.g., "That's the win"). We are reverting this to a proffesional, technical documentation voice to maintain authority.

  • Punctuation: Consistent with our style guide, we are replacing the over use of em-dashes with colons or period breaks to remove AI-generated markers + improve readability.

Screenshot 2026-05-26 at 9 38 54 PM

Why this is necessary:

We are holding this PR to ensure the "Getting Started" experience (the most high-traffic area of our site) is technically accurate and the information architecture is consistent. Merging in the current state would introduce immediate technical debt and user friction.

@quetzalliwrites

Copy link
Copy Markdown
Collaborator

Information Architecture Realignment: Removing Quickstart Anti-Pattern

As part of the v2 Getting Started experience, I am realigning our information architecture (and sidebar hierarchy) to resolve a long-standing architectural anti-pattern: housing a specific Quickstart tutorial within the general "Getting Started" folder.

Rationale for the Restructure:

  • Eliminating Cognitive Load: Titling a page "Local Development" while the internal content refers to it as a "Quickstart" creates a significant disconnect for the user. Users expect "Local Development" to cover core operational concepts (persistence, networking, dev loops); finding a specific Lambda/DynamoDB tutorial instead is a misleading user experience.

  • Getting Started as a Journey: Industry standard dictates that "Getting Started" is a high-level journey. Covering the Overview, Installation, and initial Configuration. It is the foundation, not the specific implementation.

  • Decoupling Content Types: A Quickstart is a specific functional recipe, whereas Getting Started is system onboarding. To scale effectively, we must decouple these. This realignment is the first step toward our Quickstart Library (currently tracked in this Linear DOCS Project), mirroring the successful developer experiences of enterprise leaders like Stripe and HashiCorp.

Action Taken: I am stripping the "Quickstart" branding from the "Local Development" page and reframing it as a declarative guide for deploying your first local serverless API. This ensures the folder remains a cohesive onboarding path, while the upcoming Quickstart Library will serve as the dedicated home for specialized, multi-language recipes.

@quetzalliwritesquetzalliwrites changed the title Initial draft for revising getting startedv2 Getting Started (AWS)May 28, 2026
The reference to the k8 tutorial has been moved into a standard Note component. This file is now dead code.
Removed redundant "Next Steps" clutter and relocated Docker, Compose, and Helm to a dedicated orchestration section. Standardized tone and corrected tool categorizations.
Consolidated use cases, removed duplicated MCP configuration, and deleted non-functional validation content. Standardized the tone and improved technical context throughout the guide.
@remotesynth

Copy link
Copy Markdown
CollaboratorAuthor

Updated from main and resolved merge conflicts:

Files resolved

FileResolution
astro.config.mjsKept main's consolidated Developer Tools sidebar; removed duplicate Tooling/Integrations sections
public/_redirectsUsed main's new paths, kept branch redirects for quickstart → local-development
custom-tls-certificates.mdxUpdated links to new installation/customization paths
auth-token.mdxKept branch's streamlined rewrite; dropped duplicate main content
installation.mdxKept lstk-first install flow; updated doc links to new paths; kept CLI troubleshooting
localstack-cli.mdKept full deprecated CLI reference at developer-tools/running-localstack/; merged lstk note
index.mdDeleted — branch uses index.mdx with SectionCards
quickstart.mdxDeleted — replaced by local-development.mdx (redirects preserved)
tooling/localstack-cli.mdxDeleted — canonical page is under developer-tools (redirect exists)

Additional fixes

  • Updated stale links in index.mdx (Cloud Pods, IAM, Chaos, Kubernetes)
  • Updated lstk doc links from /aws/tooling/lstk/ to /aws/developer-tools/running-localstack/lstk/

remotesynthand others added 5 commits July 10, 2026 14:06
The local development quick start builds upon the getting started steps, which required some updates to those steps. This is not complete yet.
Updated the function code as well to ensure the quick start had an easy payload to copy/paste.
Finessing the steps and adding necessary screenshots.
Resolve SSO sidebar conflict by keeping main's SCIM nested nav
alongside explicit SSO and Azure AD entries.
Co-authored-by: Cursor <cursoragent@cursor.com>
@remotesynth
remotesynth changed the base branch from aws-docs-release-july to mainJuly 13, 2026 19:07
Comment threadastro.config.mjs Outdated
Comment threadsrc/content/docs/aws/quickstart-library/index.mdx Outdated
@@ -0,0 +1,240 @@
---
title: Local Development

@quetzalliwritesquetzalliwritesJul 17, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Naming our foundational quickstart the same name as the section in our Getting Started does not make sense.

Since this is our first foundational quickstart, we want a name that highlights either the foundational nature of this quickstart or the specific action the users are doing.

App Inspector is the headline feature here.

We want a name that balances the specific tool (App Inspector) they are using + the ultimate benefit they get (iow, is seeing how their Lambda and DynamoDB talk to each other).

This quickstart specifically guides users to "Use the LocalStack Web Application to inspect, browse, snapshot, and trace the serverless API you deployed."

Thus, here are a few naming angles:

Option 1: Action & Stack Focused

These tell the user exactly what they are building right away, which makes the library look like a practical cookbook.

Example:

  • Deploying a Serverless API

Option 2: Core Platform Feature Focused

We chose to emphasize how users interact with our LocalStack Web App (the Web App, inspecting, tracing), which means we can pick a title along that angle.

Examples:

  • Web Application Tour
  • Inspecting Deployed APIs
  • Application Inspection & Tracing

@quetzalliwrites

quetzalliwrites commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Renamed foundational Quickstart to Application Inspection & Tracing

Naming our foundational quickstart the same name as the "Local Development" section in our Getting Started does not make sense.

Since this is our first foundational quickstart, we want a name that highlights either the foundational nature of this quickstart or the specific action the users are doing.

App Inspector is the headline feature here.

We want a name that balances the specific tool (App Inspector) they are using + the ultimate benefit they get (iow, is seeing how their Lambda and DynamoDB talk to each other).

This quickstart specifically guides users to "Use the LocalStack Web Application to inspect, browse, snapshot, and trace the serverless API you deployed."

Thus, here are a few naming angles:

Option 1: Action & Stack Focused

These tell the user exactly what they are building right away, which makes the library look like a practical cookbook.

Example:

  • Deploying a Serverless API

Option 2: Core Platform Feature Focused

We chose to emphasize how users interact with our LocalStack Web App (the Web App, inspecting, tracing), which means we can pick a title along that angle.

Examples:

  • Web Application Tour
  • Inspecting Deployed APIs
  • Application Inspection & Tracing

I've updated this PR to move forward with the new title, Application Inspection & Tracing.

Comment threadsrc/content/docs/aws/quickstart-library/local-development.mdx Outdated
Comment threadsrc/content/docs/aws/quickstart-library/application-inspection-tracing.mdx Outdated
Comment threadsrc/content/docs/aws/quickstart-library/index.mdx Outdated
Comment threadpublic/js/icon-loader.js Outdated
@quetzalliwrites
quetzalliwrites merged commit 608a8a5 into mainJul 17, 2026
1 of 2 checks passed
@quetzalliwrites
quetzalliwrites deleted the revise-getting-started branch July 17, 2026 19:24
Sign up for freeto 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.

5 participants

@remotesynth@quetzalliwrites@peter-smith-phd@blkgrlcto@HarshCasper