Skip to content

remove dummy content #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions src/components/SectionCards.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
import { getCollection } from 'astro:content';
import { SectionCards as SectionCardsReact } from './SectionCards.tsx';

interface Props {
basePath: string;
title?: string;
customTitles?: Record<string, string>;
useDirectFiles?: boolean;
}

const { basePath, title, customTitles = {}, useDirectFiles = false } = Astro.props;

// Get sections - either index files from subdirectories or direct files
const allSections = await getCollection('docs', ({ id }) => {
// Must start with the base path
if (!id.startsWith(basePath)) {
return false;
}

// Get the path after the base path
const relativePath = id.substring(basePath.length);

// Split into parts and filter out empty strings
const pathParts = relativePath.split('/').filter(part => part !== '');

if (useDirectFiles) {
// For direct files, we should have exactly 1 part: [filename]
// and it should not be an index file
if (pathParts.length === 1) {
const filename = pathParts[0];
return !filename.startsWith('index');
}
} else {
// For index files, we should have exactly 1 part: [subdirectory]
// because index files get the ID of their parent directory in Astro
if (pathParts.length === 1) {
// Accept any single-level subdirectory - let the content collection handle validation
return true;
}
}

return false;
});

const sortedSections = allSections.sort((a, b) => {
const titleA = a.data.title || a.data.linkTitle || '';
const titleB = b.data.title || b.data.linkTitle || '';
return titleA.localeCompare(titleB);
});

const sectionData = sortedSections.map(section => {
// Extract the key name from the section ID
const relativePath = section.id.substring(basePath.length);
const keyName = relativePath.split('/').filter(part => part !== '')[0];

// For direct files, we need to remove the file extension from the key
const cleanKey = useDirectFiles ? keyName.replace(/\.(md|mdx)$/, '') : keyName;

// Use custom title if provided, otherwise fall back to the section title
const sectionTitle = customTitles[cleanKey] || section.data.title || section.data.linkTitle || 'Unknown Section';
const description = section.data.description || `Learn more about ${sectionTitle}`;

const href = `/${section.id}`;

return {
title: sectionTitle,
description,
href
};
});


---

<SectionCardsReact
sections={sectionData}
title={title}
client:load
/>
35 changes: 35 additions & 0 deletions src/components/SectionCards.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import React from 'react';
import { ServiceBox } from './ServiceBox.tsx';

interface Section {
title: string;
description: string;
href: string;
}

interface SectionCardsProps {
sections: Section[];
title?: string;
}

export const SectionCards: React.FC<SectionCardsProps> = ({
sections,
title
}) => {
return (
<div className="searchable-services">
{title && <h2 className="section-cards-title">{title}</h2>}

<div className="service-grid">
{sections.map((section, index) => (
<ServiceBox
key={`${section.href}-${index}`}
title={section.title}
description={section.description}
href={section.href}
/>
))}
</div>
</div>
);
};
8 changes: 6 additions & 2 deletions src/content/docs/aws/capabilities/config/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
---
title: Overview
description: This is a dummy description.
description: This section describes the configuration options available for LocalStack, and how to configure them to suit your needs.
template: doc
---

# Config
This section describes the configuration options, internal mechanisms, and other LocalStack-specific features that are available to users. The following figure shows an overview of the covered topics:



![Understanding LocalStack configuration](/images/aws/understanding-localstack-overview.png)
9 changes: 0 additions & 9 deletions src/content/docs/aws/capabilities/index.md

This file was deleted.

24 changes: 24 additions & 0 deletions src/content/docs/aws/capabilities/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Capabilities
description: This section describes the capabilities of LocalStack, that go beyond the core cloud service emulation, and provide additional features and capabilities for LocalStack users.
template: doc
sidebar:
order: 5
---

import SectionCards from '../../../../components/SectionCards.astro';

By emulating cloud services locally, LocalStack enables additional features and workflows that are not feasible on the cloud.

<SectionCards
basePath="aws/capabilities/"
customTitles={{
"web-app": "LocalStack Web App",
"config": "Configuration",
"cloud-sandbox": "Cloud Sandbox",
"networking": "Networking",
"state-management": "State Management",
"chaos-engineering": "Chaos Engineering",
"security-testing": "Security Testing"
}}
/>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Accessing LocalStack via the endpoint URL
description: This is a dummy description
description: This documentation provides step-by-step guidance on how to access LocalStack services via the endpoint URL and troubleshoot common issues.
template: doc
sidebar:
order: 5
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Accessing a resource created by LocalStack
description: This is a dummy description
description: This guide will explore different scenarios and provide detailed instructions on accessing resources created by LocalStack under different scenarios.
template: doc
sidebar:
order: 6
Expand Down
5 changes: 1 addition & 4 deletions src/content/docs/aws/capabilities/networking/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: Overview
description: This is a dummy description
description: This section describes the networking capabilities of LocalStack, and how to configure them to suit your needs.
template: doc
sidebar:
order: 1
---

# Networking

4 changes: 2 additions & 2 deletions src/content/docs/aws/enterprise/enterprise-support.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Enterprise Support
description: This is a dummy description
description: This page describes the support options available for LocalStack Enterprise customers.
template: doc
sidebar:
order: 6
Expand Down Expand Up @@ -67,4 +67,4 @@ You need to fill out the following fields, which are mandatory to open a new tic
- **CI Issue?** - If the query is related to a CI issue, select the one that best fits your query from the dropdown.
- **Operating system** - From the dropdown, select the operating system you are using.
- **Affected Services** - From the dropdown, select the AWS service that is affected in your query.
- **File upload** - Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.).
- **File upload** - Here you can provide any additional files that you believe would be helpful for LocalStack support (e.g., screenshots, log files, etc.).
11 changes: 0 additions & 11 deletions src/content/docs/aws/enterprise/index.md

This file was deleted.

23 changes: 23 additions & 0 deletions src/content/docs/aws/enterprise/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: Overview
description: LocalStack Enterprise provides the most sophisticated and secure setup we offer, with advanced features and capabilities for large organizations and teams.
template: doc
sidebar:
order: 1
---

import SectionCards from '../../../../components/SectionCards.astro';

This section provides guides and resources to help you get started with LocalStack Enterprise.

<SectionCards
basePath="aws/enterprise/"
useDirectFiles={true}
customTitles={{
"enterprise-support": "Enterprise Support",
"enterprise-image": "Enterprise Image",
"k8s-operator": "Kubernetes Operator",
"kubernetes-executor": "Kubernetes Executor",
"sso": "Single Sign-On",
}}
/>
2 changes: 1 addition & 1 deletion src/content/docs/aws/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
description: This is a dummy description
description: This section describes how to get started with LocalStack using a variety of options, and provides details on how LocalStack can be configured to fit the needs of a local cloud sandbox for development, testing, and experimentation.
template: doc
sidebar:
order: 1
Expand Down
7 changes: 7 additions & 0 deletions src/content/docs/aws/integrations/app-frameworks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with your application frameworks to develop and test your applications locally.
template: doc
sidebar:
order: 1
---
7 changes: 7 additions & 0 deletions src/content/docs/aws/integrations/aws-native-tools/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with AWS Native tools to develop, deploy, and manage your infrastructure locally.
template: doc
sidebar:
order: 1
---
22 changes: 22 additions & 0 deletions src/content/docs/aws/integrations/aws-sdks/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Overview
description: Use LocalStack with AWS SDKs to manage your AWS resources locally.
template: doc
sidebar:
order: 1
---

## Introduction

LocalStack integrates with official AWS Software Development Kits (SDKs) so you can connect to LocalStack services using the same SDKs you use for AWS services.
This lets you develop and test your applications locally without connecting to the cloud.

## How to connect with AWS SDKs?

To connect to LocalStack services using AWS SDKs, you can use one of the following methods:

- **Manual configuration:** Manually configure the SDK to connect to LocalStack services by setting the endpoint URL to `http://localhost:4566` or `localhost.localstack.cloud:4566`.
This can also be specified using a [profile or an environment variable](https://docs.aws.amazon.com/sdkref/latest/guide/feature-ss-endpoints.html).
- **Transparent endpoint injection (recommended):** Connect to LocalStack services without modifying your application code.
Transparent endpoint injection uses the integrated DNS server to resolve AWS API calls to target LocalStack.
Refer to the [Transparent Endpoint Injection](/aws/capabilities/networking/transparent-endpoint-injection/) guide for more information.
7 changes: 7 additions & 0 deletions src/content/docs/aws/integrations/containers/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with container-based development tools to manage and test your infrastructure locally.
template: doc
sidebar:
order: 1
---
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Overview
description: Run LocalStack in your CI environment to test your application against a high-fidelity cloud emulator.
description: Use LocalStack in your CI environment to run tests against your AWS infrastructure in a high-fidelity cloud emulator.
template: doc
sidebar:
order: 1
Expand Down
18 changes: 17 additions & 1 deletion src/content/docs/aws/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Use your favorite cloud development tools with LocalStack.
template: doc
---

import SectionCards from '../../../../components/SectionCards.astro';

LocalStack supports a wide range of tools from the cloud development ecosystem.
This section of the documentation covers tools that are officially supported by LocalStack.

Expand All @@ -21,4 +23,18 @@ We strive to make the integration of LocalStack into your workflow as seamless a
Sometimes it's as easy as calling one of our wrapper tools, like `awslocal`, a drop-in replacement for the `aws` CLI.
Other times there is a bit of configuration involved.

Here is a list of tools we support, and documentation on how to integrate LocalStack:
Here is a list of tools we support, and documentation on how to integrate LocalStack.

<SectionCards
basePath="aws/integrations/"
customTitles={{
"app-frameworks": "App Frameworks",
"aws-native-tools": "AWS Native Tools",
"aws-sdks": "AWS SDKs",
"containers": "Containers",
"continuous-integration": "Continuous Integration",
"infrastructure-as-code": "Infrastructure as Code",
"messaging": "Messaging",
"testing": "Testing",
}}
/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with Infrastructure as Code tools to validate your infrastructure deployments and run tests against them.
template: doc
sidebar:
order: 1
---
7 changes: 7 additions & 0 deletions src/content/docs/aws/integrations/messaging/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with messaging tools, such as Kafka, to test your messaging infrastructure locally.
template: doc
sidebar:
order: 1
---
7 changes: 7 additions & 0 deletions src/content/docs/aws/integrations/testing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Overview
description: Use LocalStack with testing tools & utilities to test your application infrastructure locally.
template: doc
sidebar:
order: 1
---
5 changes: 1 addition & 4 deletions src/content/docs/aws/sample-apps.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
---
title: Sample apps
description: This is a dummy description
description: Sample apps to help LocalStack users adopt real-world scenarios to rapidly and conveniently create, configure, and deploy applications locally.
template: doc
sidebar:
order: 4
---

import ApplicationsShowcase from "../../../components/ApplicationsShowcase.astro";

# Applications
LocalStack Applications provide sample templates to help LocalStack users adopt real-world scenarios to rapidly and conveniently create, configure, and deploy applications locally. These sample applications help you establish your foundations in LocalStack and offer you a wide range of use cases and scenarios, all supported by LocalStack, to help you develop and test cloud applications efficiently.

<ApplicationsShowcase />
2 changes: 0 additions & 2 deletions src/content/docs/aws/services/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@ sidebar:

import SearchableAwsServices from '../../../../components/SearchableAwsServices.astro';

Browse LocalStack's implemented AWS services and explore their comprehensive feature sets. Each service provides detailed documentation on APIs, configuration options, and practical examples to help you get started quickly.

<SearchableAwsServices />
Loading