From ce6a11ba5219424aad2bf842f5682eae96144dc2 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Wed, 5 Jan 2022 10:41:44 -0800 Subject: [PATCH 1/3] docs: Tracer example link goes to a 404 Changes: - Update tracer link to go to https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 173a38019d..44e7802c64 100644 --- a/docs/index.md +++ b/docs/index.md @@ -67,7 +67,7 @@ Each TypeScript utility is installed as standalone NPM package. ## Examples * [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk){target="_blank"} -* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/tracing/examples){target="_blank"} +* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib){target="_blank"} * [Logger](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/logger/examples){target="_blank"} * [Metrics](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics/examples){target="_blank"} From c8cf4a9377ce67c0dca1acfe0ab7c4b5faf36b93 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Wed, 5 Jan 2022 14:16:26 -0800 Subject: [PATCH 2/3] docs: fix more lint errors and links --- README.md | 12 +++++------- docs/index.md | 3 --- 2 files changed, 5 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 2f911aa595..b2490a8cad 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools TypeScript +# AWS Lambda Powertools (TypeScript) | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p > **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | aws-devax-open-source@amazon.com** -### Features +## Features * **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions * **[Logger](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) - ## Getting started Find the complete project's [documentation here](https://awslabs.github.io/aws-lambda-powertools-typescript). @@ -36,7 +35,7 @@ Each TypeScript utility is installed as standalone NPM package. ### Examples * [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk) -* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/tracing/examples) +* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib) * [Logger](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/logger/examples) * [Metrics](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics/examples) @@ -44,12 +43,11 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). - ## Connect -* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** +* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** * **Email**: aws-lambda-powertools-feedback@amazon.com ## License -This library is licensed under the MIT-0 License. See the LICENSE file. \ No newline at end of file +This library is licensed under the MIT-0 License. See the LICENSE file. diff --git a/docs/index.md b/docs/index.md index 44e7802c64..185ce9bbf1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -45,7 +45,6 @@ Each TypeScript utility is installed as standalone NPM package. [Installation guide for the **Metrics** utility](./core/metrics.md#getting-started) - ## Environment variables !!! info @@ -63,7 +62,6 @@ Each TypeScript utility is installed as standalone NPM package. | **POWERTOOLS_LOG_DEDUPLICATION_DISABLED** | Disables log deduplication filter protection to use Pytest Live Log feature | [Logger](./core/logger) | `false` | | **LOG_LEVEL** | Sets logging level | [Logger](./core/logger) | `INFO` | - ## Examples * [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk){target="_blank"} @@ -75,7 +73,6 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn){target="_blank"} and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/){target="_blank"}. - ## Connect * **AWS Developers Slack**: `#lambda-powertools` - [Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw){target="_blank"} From be082ae9f3f2342f0a25e0c29e78d3ed099378e4 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Thu, 6 Jan 2022 04:07:32 -0800 Subject: [PATCH 3/3] docs: fix more lint errors and link --- packages/commons/README.md | 8 +++----- packages/logger/README.md | 7 +++---- packages/metrics/README.md | 8 +++----- packages/tracing/README.md | 8 +++----- 4 files changed, 12 insertions(+), 19 deletions(-) diff --git a/packages/commons/README.md b/packages/commons/README.md index 2f911aa595..19d6eeb10a 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools TypeScript +# AWS Lambda Powertools (TypeScript) | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p > **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | aws-devax-open-source@amazon.com** -### Features +## Features * **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions * **[Logger](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) - ## Getting started Find the complete project's [documentation here](https://awslabs.github.io/aws-lambda-powertools-typescript). @@ -44,10 +43,9 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). - ## Connect -* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** +* **AWS Developers Slack**: `#lambda-powertools`- **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** * **Email**: aws-lambda-powertools-feedback@amazon.com ## License diff --git a/packages/logger/README.md b/packages/logger/README.md index 2f911aa595..354da555fc 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools TypeScript +# AWS Lambda Powertools (TypeScript) | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -11,7 +11,7 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p > **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | aws-devax-open-source@amazon.com** -### Features +## Features * **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions * **[Logger](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context @@ -44,10 +44,9 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). - ## Connect -* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** +* **AWS Developers Slack**: `#lambda-powertools`- **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** * **Email**: aws-lambda-powertools-feedback@amazon.com ## License diff --git a/packages/metrics/README.md b/packages/metrics/README.md index 2f911aa595..ecd4b17454 100644 --- a/packages/metrics/README.md +++ b/packages/metrics/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools TypeScript +# AWS Lambda Powertools (TypeScript) | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p > **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | aws-devax-open-source@amazon.com** -### Features +## Features * **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions * **[Logger](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) - ## Getting started Find the complete project's [documentation here](https://awslabs.github.io/aws-lambda-powertools-typescript). @@ -44,10 +43,9 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). - ## Connect -* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** +* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** * **Email**: aws-lambda-powertools-feedback@amazon.com ## License diff --git a/packages/tracing/README.md b/packages/tracing/README.md index b540badd96..89d0badf0b 100644 --- a/packages/tracing/README.md +++ b/packages/tracing/README.md @@ -1,4 +1,4 @@ -# AWS Lambda Powertools TypeScript +# AWS Lambda Powertools (TypeScript) | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p > **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | aws-devax-open-source@amazon.com** -### Features +## Features * **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions * **[Logger](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context * **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) - ## Getting started Find the complete project's [documentation here](https://awslabs.github.io/aws-lambda-powertools-typescript). @@ -44,10 +43,9 @@ Each TypeScript utility is installed as standalone NPM package. * Credits for the Lambda Powertools idea go to [DAZN](https://github.com/getndazn) and their [DAZN Lambda Powertools](https://github.com/getndazn/dazn-lambda-powertools/). - ## Connect -* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** +* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)** * **Email**: aws-lambda-powertools-feedback@amazon.com ## License