Skip to content

docs: restructure Configuration & Integrations, add Team Workspaces#692

Open
peter-smith-phd wants to merge 1 commit into
mainfrom
dpx-493-docs-restructuring-configuration-integrations-and-team
Open

docs: restructure Configuration & Integrations, add Team Workspaces#692
peter-smith-phd wants to merge 1 commit into
mainfrom
dpx-493-docs-restructuring-configuration-integrations-and-team

Conversation

@peter-smith-phd

@peter-smith-phd peter-smith-phd commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Motivation

This is the final phase of the AWS docs restructuring. The previous structure mixed emulator configuration, installation methods, CI usage, and account/admin tasks under generic section names, which made it hard for our different user groups to find what they need. This PR reorganizes the remaining content so the navigation maps to real user intent.

It builds on the already-restructured "Connecting" and "Developer Tools" sections.

Restructuring/planning was done by me, with help from Claude to update the files. I carefully reviewed every change, and made some updates by hand.

Major changes

  • CI Pipelines (new top-level section): Continuous Integration is promoted out of Integrations into its own section, reflecting that CI is a key LocalStack use case.
  • Configuration: renamed the capabilities/ tree to configuration/, promoted Configuration Options and Logging to the top level, folded DNS Server and LocalSurf into Networking, merged the two duplicate "Internal Endpoints" pages, and grouped power-user topics under a new Advanced Features sub-section.
  • Advanced Installation (new top-level section): alternative install/runtime methods — Docker Images, Enterprise Image, Podman, Rancher Desktop, Kubernetes, DevContainers, and the Docker Extension. Kubernetes absorbs OpenShift and eksctl, with FAQ and Limitations last.
  • Integrations: narrowed to third-party integration and extensibility topics — LocalStack Extensions, LocalStack SDKs (incl. Testing Utils), App Frameworks (incl. the self-managed Kafka page), and Testing.
  • Team Workspaces (new top-level section): account/admin tasks — Accounts, Workspace, Users and Licenses, Single Sign-On (SSO + SCIM), and Stack Insights — with a group-of-people sidebar icon.
  • Removed sections: the Enterprise and LocalStack Web App groupings were dissolved and their pages redistributed.
  • Page moves: Credentials → Connecting; Instance Management → Connecting/Console (reframed as the Console-access intro); LocalStack Desktop → Developer Tools/Running LocalStack.
  • Overview & landing pages: the section overview pages now use card-based navigation with consistent summaries, the AWS landing page lists all the new top-level sections, and the quickstart "Next Steps" points at them. New colour icons matching the sidebar were added for Connecting, CI Pipelines, Team Workspaces, and Tutorials.
  • Plumbing: rewrote the sidebar in astro.config.mjs, set sidebar.order across moved pages, added sidebar icons for the new sections, updated internal cross-links throughout the docs, and added 301 redirects for every moved URL in public/_redirects.

The Astro build passes with all internal links validated.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 5, 2026

Copy link
Copy Markdown

Deploying localstack-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 205408a
Status: ✅  Deploy successful!
Preview URL: https://806c0d9e.localstack-docs.pages.dev
Branch Preview URL: https://dpx-493-docs-restructuring-c.localstack-docs.pages.dev

View logs

@peter-smith-phd peter-smith-phd force-pushed the doc-234-restructure-developer-tools branch from 4ae6ef5 to a680bd6 Compare June 15, 2026 22:05
@peter-smith-phd peter-smith-phd force-pushed the dpx-493-docs-restructuring-configuration-integrations-and-team branch from e201b37 to 8736e6b Compare June 15, 2026 22:22
Reorganize the former Capabilities and Enterprise areas into dedicated
top-level sections: Configuration, Advanced Installation, CI Pipelines,
Integrations, Team Workspaces, and Connecting. Overview pages now use
section cards, and the AWS landing page and quickstart Next Steps reflect
the new layout. public/_redirects maps the old paths to their new homes,
and new colour icons matching the sidebar are added for the new sections.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@peter-smith-phd peter-smith-phd force-pushed the dpx-493-docs-restructuring-configuration-integrations-and-team branch from ce11526 to 205408a Compare June 16, 2026 23:07
@peter-smith-phd peter-smith-phd changed the title docs: restructure Configuration & Integrations, add Team Workspaces (DPX-493) docs: restructure Configuration & Integrations, add Team Workspaces Jun 16, 2026
@peter-smith-phd peter-smith-phd changed the base branch from doc-234-restructure-developer-tools to main June 16, 2026 23:21
@peter-smith-phd peter-smith-phd marked this pull request as ready for review June 16, 2026 23:43
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