Skip to content
This repository was archived by the owner on Jul 9, 2025. It is now read-only.

Commit 0a6a76b

Browse files
committed
add pre-commit hook and enforce one line per sentence rule
1 parent dbd95b0 commit 0a6a76b

File tree

197 files changed

+3648
-1603
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

197 files changed

+3648
-1603
lines changed

.markdownlint-cli2.yaml

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,25 @@ globs:
22
- 'content/**/*.md'
33
ignores:
44
- 'node_modules'
5+
# Weird behavior with markdownlint; TODO: Fix
6+
- 'content/en/tutorials/cloud-pods-collaborative-debugging/*'
7+
- 'content/en/user-guide/integrations/terraform/*'
58
customRules:
69
- markdownlint-rule-max-one-sentence-per-line
710
config:
8-
MD029: false
9-
MD046: false
10-
MD025: false
11-
MD001: false
12-
MD024: false
13-
MD055: false
14-
MD056: false
15-
MD036: false
16-
MD003: false
17-
MD033: false
18-
MD013: false
19-
MD034: false
20-
MD032: false
11+
MD029: false # Ordered list item prefix
12+
MD046: false # Code block style
13+
MD025: false # Single H1
14+
MD001: false # Header levels increment by one
15+
MD024: false # Multiple headers with the same content
16+
MD055: false # Inconsistent leading and trailing pipe characters
17+
MD056: false # Inconsistent Table column count
18+
MD036: false # Emphasis used instead of a header
19+
MD003: false # Header style
20+
MD033: false # Inline HTML
21+
MD013: false # Line length
22+
MD034: false # Bare URL used
23+
MD032: false # Lists should be surrounded by blank lines
2124
blanks-around-headings:
2225
lines_above: 0
2326
lines_below: 1

.pre-commit-config.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
repos:
2+
- repo: https://github.com/DavidAnson/markdownlint-cli2
3+
rev: v0.13.0
4+
hooks:
5+
- id: markdownlint-cli2
6+
args: ['--fix']

content/en/academy/localstack-101/lesson-3/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ url: "/academy/localstack-101/why-localstack/"
1414
---
1515

1616
Let's imagine this scenario: Alice, a software developer, takes on the task of creating a serverless
17-
Web application on AWS Cloud. However, she faces slow and tedious development due to cloud dependencies (DBs, VMs, MQs, etc.).
17+
Web application on AWS Cloud.
18+
However, she faces slow and tedious development due to cloud dependencies (DBs, VMs, MQs, etc.).
1819
Every local change needs to be packaged and uploaded to the cloud for testing.
1920
The solution for her trouble is LocalStack — a revolutionary platform that brings cloud resources to her
2021
local machine, enabling efficient development and testing.

content/en/academy/localstack-101/lesson-4/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ Discover multiple pathways to initiate your LocalStack experience:
1919
You'll understand the diverse approaches to LocalStack installation:
2020

2121
1. Quickstart with LocalStack CLI:
22-
- Install `awscli-local` and `localstack` via `pip install`. On macOS you can use `brew install`.
22+
- Install `awscli-local` and `localstack` via `pip install`.
23+
On macOS you can use `brew install`.
2324
- Start LocalStack using `localstack start`.
2425
- Create a bucket and list buckets using `awslocal s3 mb s3://test` and `awslocal s3 ls`.
2526
2. Alternative - Docker: Dive into an alternate installation method using Docker: pull the image and run it, it's that easy.

content/en/academy/localstack-101/lesson-5/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ In this informative video we guide you through the essential steps of the LocalS
1818
- Witness the seamless login flow and discover how to configure the web app.
1919
- Learn how to effortlessly connect your LocalStack Account to enable a smooth integration experience.
2020
- Explore the Resource Browser as we demonstrate how to list and create fundamental resources.
21-
- To create an account for LocalStack, visit [app.localstack.cloud/sign-up](https://app.localstack.cloud/sign-up). You can sign up with your email address or one of our supported social identity providers (such as GitHub).
21+
- To create an account for LocalStack, visit [app.localstack.cloud/sign-up](https://app.localstack.cloud/sign-up).
22+
You can sign up with your email address or one of our supported social identity providers (such as GitHub).
2223

2324
Further reading:
2425

content/en/academy/localstack-101/lesson-6/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ url: "/academy/localstack-101/full-project-demo/"
1414

1515
Discover the ins and outs of one of our Developer Hub's practical sample applications—a note-taking platform.
1616
This video tutorial offers a comprehensive walk-through, beginning with the checkout of the GitHub project and
17-
culminating in deploying the operational application on LocalStack. Covering the essentials, we'll guide you
17+
culminating in deploying the operational application on LocalStack.
18+
Covering the essentials, we'll guide you
1819
through dependency installation, backend and frontend build, and a detailed exploration of the application's service
1920
diagram to unveil the integral components at play.
2021

content/en/academy/localstack-development/lesson-2/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ type: lessons
1111
url: "/academy/localstack-deployment/deploy-app-ls/"
1212
---
1313

14-
In this lesson, we'll guide you through deploying a [continer-based application](https://github.com/localstack/localstack-workshop/tree/main/02-serverless-api-ecs-apigateway), which mimics the complexity of a real-world application. We are using the following AWS services and their features to build our infrastructure:
14+
In this lesson, we'll guide you through deploying a [continer-based application](https://github.com/localstack/localstack-workshop/tree/main/02-serverless-api-ecs-apigateway), which mimics the complexity of a real-world application.
15+
We are using the following AWS services and their features to build our infrastructure:
1516

1617
- [Elastic Container Service](https://docs.localstack.cloud/user-guide/aws/elastic-container-service/) to create and deploy our containerized application.
1718
- [DynamoDB](https://docs.localstack.cloud/user-guide/aws/dynamodb/) as a key-value and document database to persist our data.

content/en/academy/localstack-development/lesson-3/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,11 @@ type: lessons
1111
url: "/academy/localstack-deployment/ls-integrations/"
1212
---
1313

14-
LocalStack integrates with various Infrastructure as Code tools like [Terraform](https://docs.localstack.cloud/user-guide/integrations/terraform/) or [Pulumi](https://docs.localstack.cloud/user-guide/integrations/pulumi/) assist in configuration management with added advantages like version control, ease of editing, and reproducibility. Additionally, LocalStack integrates with various CI platforms, such as [GitHub Actions](https://docs.localstack.cloud/user-guide/ci/github-actions/) or [CircleCI](https://docs.localstack.cloud/user-guide/ci/circle-ci/), to enable the cloud integrations tests before pushing changes to production.
14+
LocalStack integrates with various Infrastructure as Code tools like [Terraform](https://docs.localstack.cloud/user-guide/integrations/terraform/) or [Pulumi](https://docs.localstack.cloud/user-guide/integrations/pulumi/) assist in configuration management with added advantages like version control, ease of editing, and reproducibility.
15+
Additionally, LocalStack integrates with various CI platforms, such as [GitHub Actions](https://docs.localstack.cloud/user-guide/ci/github-actions/) or [CircleCI](https://docs.localstack.cloud/user-guide/ci/circle-ci/), to enable the cloud integrations tests before pushing changes to production.
1516

16-
We discuss how LocalStack integrates with infrastructure-as-code (IaC) and continuous integration (CI) tools. Towards the end, we'll demonstrate a [Terraform deployment of a PostgreSQL Aurora cluster](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/v8.1.1/examples/postgresql) on LocalStack, highlighting the time and resource savings compared to deploying directly on AWS.
17+
We discuss how LocalStack integrates with infrastructure-as-code (IaC) and continuous integration (CI) tools.
18+
Towards the end, we'll demonstrate a [Terraform deployment of a PostgreSQL Aurora cluster](https://github.com/terraform-aws-modules/terraform-aws-rds-aurora/tree/v8.1.1/examples/postgresql) on LocalStack, highlighting the time and resource savings compared to deploying directly on AWS.
1719

1820
Additionally, we'll provide examples of using LocalStack with Terraform and Pulumi for reference.
1921

content/en/academy/localstack-development/lesson-4/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ type: lessons
1111
url: "/academy/localstack-deployment/infra-terraform/"
1212
---
1313

14-
In this video, we'll utilize Terraform to deploy AWS resources locally through LocalStack. These resources include DynamoDB tables, API Gateway, and VPC. We'll use `tflocal`, a wrapper CLI that serves as a wrapper on the `terraform` CLI to execute Terraform commands against LocalStack.
14+
In this video, we'll utilize Terraform to deploy AWS resources locally through LocalStack.
15+
These resources include DynamoDB tables, API Gateway, and VPC.
16+
We'll use `tflocal`, a wrapper CLI that serves as a wrapper on the `terraform` CLI to execute Terraform commands against LocalStack.
1517

1618
Here's a breakdown of the steps we'll take:
1719

content/en/academy/localstack-development/lesson-5/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ type: lessons
1111
url: "/academy/localstack-deployment/infra-cloudformation/"
1212
---
1313

14-
In this video, we'll utilize [AWS CloudFormation](https://docs.localstack.cloud/user-guide/aws/cloudformation/) to deploy AWS resources locally through LocalStack. These resources include DynamoDB tables, API Gateway, and VPC. We'll use `awslocal`, a wrapper CLI that serves as a wrapper on the `aws` CLI to execute Terraform commands against LocalStack.
14+
In this video, we'll utilize [AWS CloudFormation](https://docs.localstack.cloud/user-guide/aws/cloudformation/) to deploy AWS resources locally through LocalStack.
15+
These resources include DynamoDB tables, API Gateway, and VPC.
16+
We'll use `awslocal`, a wrapper CLI that serves as a wrapper on the `aws` CLI to execute Terraform commands against LocalStack.
1517

1618
Here's a breakdown of the steps we'll take:
1719

0 commit comments

Comments
 (0)