diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc233400d1..1a7dccd056 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -75,7 +75,7 @@ Work your magic. Before starting, make sure to check the [Getting Started](#Gett * Create a commit with your changes and push them to a [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo). - > Note: Core members can push directly to a branch on the AWS Lambda Powertools (TypeScript) repo (following the same conventions detailed below). + > Note: Core members can push directly to a branch on the AWS Lambda Powertools for TypeScript repo (following the same conventions detailed below). * Create a [pull request on GitHub](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). * Pull request title and message (and PR title and description) must adhere to @@ -113,7 +113,7 @@ Work your magic. Before starting, make sure to check the [Getting Started](#Gett ## Getting Started -The following steps describe how to set up the AWS Lambda Powertools (TypeScript) repository on your local machine. +The following steps describe how to set up the AWS Lambda Powertools for TypeScript repository on your local machine. The alternative is to use a Cloud IDE like [Gitpod](https://www.gitpod.io/) or [Codespaces](https://github.com/features/codespaces) for your development. ### Setup diff --git a/README.md b/README.md index 28d4e55822..912862e4d1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# AWS Lambda Powertools (TypeScript) +# AWS Lambda Powertools for TypeScript | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_ -A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). +A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). **[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)** @@ -22,7 +22,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started) diff --git a/docs/index.md b/docs/index.md index 9b45add122..f1db1e5e24 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ --- title: Homepage -description: AWS Lambda Powertools TypeScript +description: AWS Lambda Powertools for TypeScript --- !!! warning "Do not use this library in production" @@ -10,7 +10,7 @@ description: AWS Lambda Powertools TypeScript **Do not use this library for production workloads.** -AWS Lambda Powertools TypeScript provides a suite of utilities for AWS Lambda functions running on the Node.js runtime, to ease the adoption of best practices such as tracing, structured logging, custom metrics, and more. +AWS Lambda Powertools for TypeScript provides a suite of utilities for AWS Lambda functions running on the Node.js runtime, to ease the adoption of best practices such as tracing, structured logging, custom metrics, and more. ## Tenets @@ -33,7 +33,7 @@ Core utilities such as Tracer, Logger, Metrics, and Event Handler will be availa ## Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3){target="_blank"}. +The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3){target="_blank"}. Each TypeScript utility is installed as standalone NPM package. [Installation guide for the **Tracer** utility](./core/tracer.md#getting-started) diff --git a/examples/cdk/README.md b/examples/cdk/README.md index fb52422baf..11d0b35ebc 100644 --- a/examples/cdk/README.md +++ b/examples/cdk/README.md @@ -1,6 +1,6 @@ -# AWS Lambda Powertools (TypeScript) examples in CDK +# AWS Lambda Powertools for TypeScript examples in CDK -This is a deployable CDK app that deploys AWS Lambda functions as part of a CloudFormation stack. These Lambda functions use the utilities made available as part of AWS Lambda Powertools (TypeScript) to demonstrate their usage. +This is a deployable CDK app that deploys AWS Lambda functions as part of a CloudFormation stack. These Lambda functions use the utilities made available as part of AWS Lambda Powertools for TypeScript to demonstrate their usage. You will need to have a valid AWS Account in order to deploy these resources. These resources may incur costs to your AWS Account. The cost from **some services** are covered by the [AWS Free Tier](https://aws.amazon.com/free/?all-free-tier.sort-by=item.additionalFields.SortRank&all-free-tier.sort-order=asc&awsf.Free%20Tier%20Types=*all&awsf.Free%20Tier%20Categories=*all) but not all of them. If you don't have an AWS Account follow [these instructions to create one](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/). diff --git a/mkdocs.yml b/mkdocs.yml index 0022c035f8..ae25541124 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Lambda Powertools TypeScript +site_name: AWS Lambda Powertools for TypeScript site_description: AWS Lambda Powertools for TypeScript site_author: Amazon Web Services repo_url: https://github.com/awslabs/aws-lambda-powertools-typescript diff --git a/packages/commons/README.md b/packages/commons/README.md index 19d6eeb10a..b7454e2059 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -1,11 +1,11 @@ -# AWS Lambda Powertools (TypeScript) +# AWS Lambda Powertools for TypeScript | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_ -A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). +A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). **[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)** @@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The AWS Lambda Powertools for TypeScript utilities (which from here will be referred as Powertools) follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started) diff --git a/packages/commons/package.json b/packages/commons/package.json index 71168167e2..a4fdd697ef 100644 --- a/packages/commons/package.json +++ b/packages/commons/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/commons", "version": "0.6.0", - "description": "A shared utility package for AWS Lambda powertools (TypeScript) libraries", + "description": "A shared utility package for AWS Lambda Powertools for TypeScript libraries", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/logger/README.md b/packages/logger/README.md index 354da555fc..b496f59408 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -1,11 +1,11 @@ -# AWS Lambda Powertools (TypeScript) +# AWS Lambda Powertools for TypeScript | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_ -A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). +A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). **[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)** @@ -24,7 +24,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started) diff --git a/packages/logger/package.json b/packages/logger/package.json index 1b0d2983a1..04a9adfb8e 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/logger", "version": "0.6.0", - "description": "The logging package for the AWS Lambda powertools (TypeScript) library", + "description": "The logging package for the AWS Lambda Powertools for TypeScript library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/metrics/README.md b/packages/metrics/README.md index ecd4b17454..039cc93da2 100644 --- a/packages/metrics/README.md +++ b/packages/metrics/README.md @@ -1,11 +1,11 @@ -# AWS Lambda Powertools (TypeScript) +# AWS Lambda Powertools for TypeScript | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_ -A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). +A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). **[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)** @@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started) diff --git a/packages/metrics/package.json b/packages/metrics/package.json index a16708f666..c676851f1c 100644 --- a/packages/metrics/package.json +++ b/packages/metrics/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/metrics", "version": "0.6.0", - "description": "The metrics package for the AWS Lambda powertools (TypeScript) library", + "description": "The metrics package for the AWS Lambda Powertools for TypeScript library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com" diff --git a/packages/tracing/README.md b/packages/tracing/README.md index 89d0badf0b..f3fd5d58ed 100644 --- a/packages/tracing/README.md +++ b/packages/tracing/README.md @@ -1,11 +1,11 @@ -# AWS Lambda Powertools (TypeScript) +# AWS Lambda Powertools for TypeScript | ⚠️ **WARNING: Do not use this library in production** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
This version is not stable, and significant breaking changes might incur as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2). |_ -A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Python](https://github.com/awslabs/aws-lambda-powertools-python) and [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). +A suite of TypeScript utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools for [Python](https://github.com/awslabs/aws-lambda-powertools-python) and AWS Lambda Powertools for [Java](https://github.com/awslabs/aws-lambda-powertools-java) are also available). **[📜 Documentation](https://awslabs.github.io/aws-lambda-powertools-typescript/)** | **[NPM](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Examples](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)** @@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). +The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3). Each TypeScript utility is installed as standalone NPM package. 👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started) diff --git a/packages/tracing/package.json b/packages/tracing/package.json index 07f24e199f..318b50cffa 100644 --- a/packages/tracing/package.json +++ b/packages/tracing/package.json @@ -1,7 +1,7 @@ { "name": "@aws-lambda-powertools/tracer", "version": "0.6.0", - "description": "The tracer package for the AWS Lambda powertools (TypeScript) library", + "description": "The tracer package for the AWS Lambda Powertools for TypeScript library", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com"