chore(docs): add link to performance tuning demo (#1960)

aws-powertools · Jan 25, 2024 · 76fc20c · 76fc20c
1 parent a9e5ba6
commit 76fc20c
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ You can use the library in both TypeScript and JavaScript code bases.
     - [Lambda layers](#lambda-layers)
     - [NPM modules](#npm-modules)
   - [Examples](#examples)
-  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+  - [Demo applications](#demo-applications)
 - [Contribute](#contribute)
 - [Roadmap](#roadmap)
 - [Connect](#connect)
@@ -82,11 +82,13 @@ Or refer to the installation guide of each utility:
 * [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
 * [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
 
-### Serverless TypeScript Demo application
+### Demo applications
 
 The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript).  
 You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+The [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
+
 ## Contribute
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).

diff --git a/docs/index.md b/docs/index.md
@@ -63,7 +63,7 @@ You can include Powertools for AWS Lambda (TypeScript) Lambda Layer using [AWS L
     | `eu-south-1`     | [arn:aws:lambda:eu-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:     |
     | `eu-south-2`     | [arn:aws:lambda:eu-south-2:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:     |
     | `ca-central-1`   | [arn:aws:lambda:ca-central-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:   |
-    | `ca-west-1`      | [arn:aws:lambda:ca-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:   |
+    | `ca-west-1`      | [arn:aws:lambda:ca-west-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:      |
     | `sa-east-1`      | [arn:aws:lambda:sa-east-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:      |
     | `af-south-1`     | [arn:aws:lambda:af-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:     |
     | `me-south-1`     | [arn:aws:lambda:me-south-1:094274105915:layer:AWSLambdaPowertoolsTypeScript:27](#){: .copyMe}:clipboard:     |
@@ -277,7 +277,8 @@ The project's repository includes examples of how to instrument your functions b
 * [AWS CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk){target="_blank"}
 * [AWS SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam){target="_blank"}
 
-If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly more complex use case, check the [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo). You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
+If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly more complex use case, check the [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) or the [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository. Both demos use Powertools for AWS Lambda (TypeScript) as well as demonstrating other common techniques for Lambda functions written in TypeScript.
+
 
 ## Features
 

diff --git a/packages/commons/README.md b/packages/commons/README.md
@@ -15,7 +15,7 @@ You can use the library in both TypeScript and JavaScript code bases.
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Examples](#examples)
-  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+  - [Demo applications](#demo-applications)
 - [Contribute](#contribute)
 - [Roadmap](#roadmap)
 - [Connect](#connect)
@@ -66,11 +66,13 @@ Or refer to the installation guide of each utility:
 * [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
 * [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
 
-### Serverless TypeScript Demo application
+### Demo applications
 
 The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript).  
 You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+The [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
+
 ## Contribute
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).

diff --git a/packages/logger/README.md b/packages/logger/README.md
@@ -14,7 +14,7 @@ You can use the library in both TypeScript and JavaScript code bases.
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Examples](#examples)
-  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+  - [Demo applications](#demo-applications)
 - [Contribute](#contribute)
 - [Roadmap](#roadmap)
 - [Connect](#connect)
@@ -63,11 +63,13 @@ Or refer to the installation guide of each utility:
 * [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
 * [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
 
-### Serverless TypeScript Demo application
+### Demo applications
 
 The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript).  
 You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+The [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
+
 ## Contribute
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).

diff --git a/packages/metrics/README.md b/packages/metrics/README.md
@@ -14,7 +14,7 @@ You can use the library in both TypeScript and JavaScript code bases.
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Examples](#examples)
-  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+  - [Demo applications](#demo-applications)
 - [Contribute](#contribute)
 - [Roadmap](#roadmap)
 - [Connect](#connect)
@@ -62,11 +62,13 @@ Or refer to the installation guide of each utility:
 * [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
 * [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
 
-### Serverless TypeScript Demo application
+### Demo applications
 
 The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript).  
 You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+The [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
+
 ## Contribute
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).

diff --git a/packages/tracer/README.md b/packages/tracer/README.md
@@ -14,7 +14,7 @@ You can use the library in both TypeScript and JavaScript code bases.
 - [Getting started](#getting-started)
   - [Installation](#installation)
   - [Examples](#examples)
-  - [Serverless TypeScript Demo application](#serverless-typescript-demo-application)
+  - [Demo applications](#demo-applications)
 - [Contribute](#contribute)
 - [Roadmap](#roadmap)
 - [Connect](#connect)
@@ -62,11 +62,13 @@ Or refer to the installation guide of each utility:
 * [CDK](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/cdk)
 * [SAM](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples/sam)
 
-### Serverless TypeScript Demo application
+### Demo applications
 
 The [Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo) shows how to use Powertools for AWS Lambda (TypeScript).  
 You can find instructions on how to deploy and load test this application in the [repository](https://github.com/aws-samples/serverless-typescript-demo).
 
+The [AWS Lambda performance tuning](https://github.com/aws-samples/optimizations-for-lambda-functions) repository also uses Powertools for AWS Lambda (TypeScript) as well as demonstrating other performance tuning techniques for Lambda functions written in TypeScript.
+
 ## Contribute
 
 If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).