Skip to content

Commit a7e6f54

Browse files
authored
chore: fix docs. add links (#582)
1 parent 2e8115a commit a7e6f54

File tree

2 files changed

+4
-18
lines changed

2 files changed

+4
-18
lines changed

docs/index.md

+3-18
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,10 @@ Starting a Serverless service can be overwhelming. You need to figure out many q
1414
- How to write a SaaS-oriented CI/CD pipeline? What does it need to contain?
1515
- How do you handle observability, logging, tracing, metrics?
1616
- How do you handle testing?
17-
- What makes an AWS Lambda handler resilient, traceable, and easy to maintain? How do you write such a code?
1817

1918
## **The Solution**
2019

21-
This project aims to reduce cognitive load and answer these questions for you by providing a skeleton Python Serverless service template
22-
23-
that implements best practices for AWS Lambda, Serverless CI/CD, and AWS CDK in one template project.
20+
This project aims to reduce cognitive load and answer these questions for you by providing a skeleton Python Serverless service template that implements best practices for AWS Lambda, Serverless CI/CD, and AWS CDK in one template project.
2421

2522
### Serverless Service - The Order service
2623

@@ -35,9 +32,10 @@ that implements best practices for AWS Lambda, Serverless CI/CD, and AWS CDK in
3532
- Python Serverless service with a recommended file structure.
3633
- CDK infrastructure with infrastructure tests and security tests.
3734
- CI/CD pipelines based on Github actions that deploys to AWS with python linters, complexity checks and style formatters.
35+
- Makefile for simple developer experience.
3836
- The AWS Lambda handler embodies Serverless best practices and has all the bells and whistles for a proper production ready handler.
3937
- AWS Lambda handler uses [AWS Lambda Powertools](https://awslabs.github.io/aws-lambda-powertools-python/){:target="_blank" rel="noopener"}.
40-
- Unit, integration and E2E tests.
38+
- Unit, infrastructure, integration and E2E tests.
4139

4240
The GitHub template project can be found at [https://github.com/ran-isenberg/aws-lambda-handler-cookbook](https://github.com/ran-isenberg/aws-lambda-handler-cookbook){:target="_blank" rel="noopener"}.
4341

@@ -58,19 +56,6 @@ The utilities cover multiple aspects of a production-ready service, including:
5856

5957
While the code examples are written in Python, the principles are valid to any supported AWS Lambda handler programming language.
6058

61-
## **The Blog Series**
62-
63-
The template is based on my AWS Lambda handler cookbook blog series that I published at [ranthebuilder.cloud](https://www.ranthebuilder.cloud).
64-
65-
- [Logging](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-1-logging){:target="_blank" rel="noopener"}
66-
- [Observability: Monitoring and Tracing](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-2-observability){:target="_blank" rel="noopener"}
67-
- [Observability: Business KPIs Metrics](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-3-business-domain-observability){:target="_blank" rel="noopener"}
68-
- [Environment Variables](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-environment-variables){:target="_blank" rel="noopener"}
69-
- [Input Validation](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-elevate-your-handler-s-code-part-5-input-validation){:target="_blank" rel="noopener"}
70-
- [Dynamic Configuration & feature flags](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-part-6-feature-flags-configuration-best-practices){:target="_blank" rel="noopener"}
71-
- [Start Your AWS Serverless Service With Two Clicks](https://www.ranthebuilder.cloud/post/aws-lambda-cookbook-part-7-how-to-use-the-aws-lambda-cookbook-github-template-project){:target="_blank" rel="noopener"}
72-
- [CDK Best practices](https://github.com/ran-isenberg/aws-lambda-handler-cookbook){:target="_blank" rel="noopener"}
73-
7459
## **License**
7560

7661
This library is licensed under the MIT License. See the [LICENSE](https://github.com/ran-isenberg/aws-lambda-handler-cookbook/blob/main/LICENSE) file.

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ nav:
1717
- best_practices/input_validation.md
1818
- best_practices/dynamic_configuration.md
1919
- CDK Best practices: https://www.ranthebuilder.cloud/post/aws-cdk-best-practices-from-the-trenches" target="_blank"
20+
- Testing Best practices: https://www.ranthebuilder.cloud/post/guide-to-serverless-lambda-testing-best-practices-part-1" target="_blank"
2021

2122
theme:
2223
name: material

0 commit comments

Comments
 (0)