Skip to content

Commit 5203010

Browse files
authored
docs: fix docs (ran-isenberg#599)
1 parent 44707db commit 5203010

File tree

5 files changed

+13
-6
lines changed

5 files changed

+13
-6
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,13 @@ This project aims to reduce cognitive load and answer these questions for you by
4343

4444
- Python Serverless service with a recommended file structure.
4545
- CDK infrastructure with infrastructure tests and security tests.
46-
- CI/CD pipelines based on Github actions that deploys to AWS with python linters, static code analysis, complexity checks and style formatters.
46+
- CI/CD pipelines based on Github actions that deploys to AWS with python linters, complexity checks and style formatters.
47+
- Makefile for simple developer experience.
4748
- The AWS Lambda handler embodies Serverless best practices and has all the bells and whistles for a proper production ready handler.
48-
- AWS Lambda handler uses [AWS Lambda Powertools](https://awslabs.github.io/aws-lambda-powertools-python/).
49-
- Unit, integration and E2E tests.
49+
- AWS Lambda handler uses [AWS Lambda Powertools](https://awslabs.github.io/aws-lambda-powertools-python/){:target="_blank" rel="noopener"}.
50+
- AWS Lambda handler 3 layer architecture: handler layer, logic layer and data access layer
51+
- Features flags and configuration based on AWS AppConfig
52+
- Unit, infrastructure, security, integration and E2E tests.
5053

5154

5255
## CDK Deployment

docs/best_practices/dynamic_configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ You need to add two new settings in order to use this utility:
9191

9292
=== "cdk_lambda.py"
9393

94-
```python hl_lines="12-17 37-40"
94+
```python hl_lines="15-22 46-49"
9595
--8<-- "docs/examples/best_practices/dynamic_configuration/lambda_cdk.py"
9696
```
9797

docs/cdk.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ All ASW Lambda function configurations are saved as constants at the `cdk.my_ser
4545
- **Lambda Role** - The role of the Lambda function.
4646
- **API GW with Lambda Integration** - API GW with a Lambda integration POST /api/orders that triggers the Lambda function.
4747
- **AWS DynamoDB table** - stores request data. Created in its own construct: api_db_construct.py
48+
- Construct: **cdk.my_service.configuration.configuration_construct.py** which includes:
49+
- AWS AppConfig configuration with an environment, application, configuration and deployment strategy. You can read more about it [here.](best_practices/dynamic_configuration.md)
4850

4951
### **Infrastructure CDK & Security Tests**
5052

docs/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: AWS Lambda Cookbook Project Getting started
1212

1313
## **Creating a Developer Environment**
1414

15-
1. Run ``poetry shell`
1615
1. Run ``make dev``
16+
2. Run ``poetry install``
1717

1818
## **Deploy CDK**
1919

docs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@ This project aims to reduce cognitive load and answer these questions for you by
3535
- Makefile for simple developer experience.
3636
- The AWS Lambda handler embodies Serverless best practices and has all the bells and whistles for a proper production ready handler.
3737
- AWS Lambda handler uses [AWS Lambda Powertools](https://awslabs.github.io/aws-lambda-powertools-python/){:target="_blank" rel="noopener"}.
38-
- Unit, infrastructure, integration and E2E tests.
38+
- AWS Lambda handler 3 layer architecture: handler layer, logic layer and data access layer
39+
- Features flags and configuration based on AWS AppConfig
40+
- Unit, infrastructure, security, integration and E2E tests.
3941

4042
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"}.
4143

0 commit comments

Comments
 (0)