From a3a6c9072d248c19bfb202bc5fe45c46d740d0d0 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Fri, 24 Jun 2022 19:50:20 +0200 Subject: [PATCH 1/3] docs: updated docs to reflect RC status --- README.md | 4 ++-- docs/core/logger.md | 8 ++++---- docs/core/metrics.md | 8 ++++---- docs/core/tracer.md | 8 ++++---- docs/index.md | 8 ++++---- packages/commons/README.md | 4 ++-- packages/logger/README.md | 4 ++-- packages/metrics/README.md | 4 ++-- packages/tracer/README.md | 4 ++-- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 3db5a22b10..4189368e0c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # AWS Lambda Powertools for TypeScript -| ⚠️ **WARNING: Do not use this library in production** ⚠️ | +| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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). |_ +| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
While this version is fairly stable in terms of API surface, we still expect some changes to happen 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 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). diff --git a/docs/core/logger.md b/docs/core/logger.md index 621e4c58e1..0c632fceaa 100644 --- a/docs/core/logger.md +++ b/docs/core/logger.md @@ -3,12 +3,12 @@ title: Logger description: Core utility --- -!!! warning "Do not use this library in production" +!!! warning "Do not use this library in production (yet)" - 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){target="_blank"}. + AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. + While this version is fairly stable in terms of API surface, we still expect some changes to happen as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2){target="_blank"}. - **Do not use this library for production workloads.** + **Do not use this library for production workloads (yet).** Logger provides an opinionated logger with output structured as JSON. diff --git a/docs/core/metrics.md b/docs/core/metrics.md index bfe04aa609..3a9fb02b52 100644 --- a/docs/core/metrics.md +++ b/docs/core/metrics.md @@ -3,12 +3,12 @@ title: Metrics description: Core utility --- -!!! warning "Do not use this library in production" +!!! warning "Do not use this library in production (yet)" - 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){target="_blank"}. + AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. + While this version is fairly stable in terms of API surface, we still expect some changes to happen as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2){target="_blank"}. - **Do not use this library for production workloads.** + **Do not use this library for production workloads (yet).** Metrics creates custom metrics asynchronously by logging metrics to standard output following [Amazon CloudWatch Embedded Metric Format (EMF)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format.html). diff --git a/docs/core/tracer.md b/docs/core/tracer.md index 4f8241f1e2..cf5ff06995 100644 --- a/docs/core/tracer.md +++ b/docs/core/tracer.md @@ -3,12 +3,12 @@ title: Tracer description: Core utility --- -!!! warning "Do not use this library in production" +!!! warning "Do not use this library in production (yet)" - 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){target="_blank"}. + AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. + While this version is fairly stable in terms of API surface, we still expect some changes to happen as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2){target="_blank"}. - **Do not use this library for production workloads.** + **Do not use this library for production workloads (yet).** Tracer is an opinionated thin wrapper for [AWS X-Ray SDK for Node.js](https://github.com/aws/aws-xray-sdk-node). diff --git a/docs/index.md b/docs/index.md index 60fb5d621a..3d976eb5a5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,12 +3,12 @@ title: Homepage description: AWS Lambda Powertools for TypeScript --- -!!! warning "Do not use this library in production" +!!! warning "Do not use this library in production (yet)" - 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){target="_blank"}. + AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. + While this version is fairly stable in terms of API surface, we still expect some changes to happen as part of the upcoming [production-ready release](https://github.com/awslabs/aws-lambda-powertools-typescript/milestone/2){target="_blank"}. - **Do not use this library for production workloads.** + **Do not use this library for production workloads (yet).** 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. diff --git a/packages/commons/README.md b/packages/commons/README.md index e7b55ef421..0feaf821c3 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -1,8 +1,8 @@ # AWS Lambda Powertools for TypeScript -| ⚠️ **WARNING: Do not use this library in production** ⚠️ | +| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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). |_ +| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
While this version is fairly stable in terms of API surface, we still expect some changes to happen 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 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). diff --git a/packages/logger/README.md b/packages/logger/README.md index fc46544a06..3ef9f324a9 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -1,8 +1,8 @@ # AWS Lambda Powertools for TypeScript -| ⚠️ **WARNING: Do not use this library in production** ⚠️ | +| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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). |_ +| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
While this version is fairly stable in terms of API surface, we still expect some changes to happen 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 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). diff --git a/packages/metrics/README.md b/packages/metrics/README.md index f5633380fb..47294b6964 100644 --- a/packages/metrics/README.md +++ b/packages/metrics/README.md @@ -1,8 +1,8 @@ # AWS Lambda Powertools for TypeScript -| ⚠️ **WARNING: Do not use this library in production** ⚠️ | +| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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). |_ +| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
While this version is fairly stable in terms of API surface, we still expect some changes to happen 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 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). diff --git a/packages/tracer/README.md b/packages/tracer/README.md index f22574317f..91a3cf4a5a 100644 --- a/packages/tracer/README.md +++ b/packages/tracer/README.md @@ -1,8 +1,8 @@ # AWS Lambda Powertools for TypeScript -| ⚠️ **WARNING: Do not use this library in production** ⚠️ | +| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ | |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 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). |_ +| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
While this version is fairly stable in terms of API surface, we still expect some changes to happen 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 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). From 20df11f5501592960d27148a5cf03c6c066d6c5d Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Sat, 25 Jun 2022 13:40:20 +0200 Subject: [PATCH 2/3] chore: added keywords + removed extra tag from readme --- packages/commons/README.md | 2 +- packages/commons/package.json | 9 +++++++-- packages/logger/package.json | 11 +++++++++-- packages/metrics/package.json | 10 ++++++++-- packages/tracer/package.json | 11 +++++++++-- 5 files changed, 34 insertions(+), 9 deletions(-) diff --git a/packages/commons/README.md b/packages/commons/README.md index 0feaf821c3..86a5040cbc 100644 --- a/packages/commons/README.md +++ b/packages/commons/README.md @@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l ### Installation -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"}. +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/commons/package.json b/packages/commons/package.json index 9221a602b8..7ba06b6d3f 100644 --- a/packages/commons/package.json +++ b/packages/commons/package.json @@ -40,5 +40,10 @@ }, "bugs": { "url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues" - } -} + }, + "keywords": [ + "aws", + "lambda", + "powertools" + ] +} \ No newline at end of file diff --git a/packages/logger/package.json b/packages/logger/package.json index b62f36ae78..264e01927c 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -54,5 +54,12 @@ "lodash.clonedeep": "^4.5.0", "lodash.merge": "^4.6.2", "lodash.pickby": "^4.6.0" - } -} + }, + "keywords": [ + "aws", + "lambda", + "powertools", + "logger", + "logging" + ] +} \ No newline at end of file diff --git a/packages/metrics/package.json b/packages/metrics/package.json index 237c949a2b..f6a27c2d35 100644 --- a/packages/metrics/package.json +++ b/packages/metrics/package.json @@ -50,5 +50,11 @@ }, "dependencies": { "@aws-lambda-powertools/commons": "^0.11.1-rc.0" - } -} + }, + "keywords": [ + "aws", + "lambda", + "powertools", + "metrics" + ] +} \ No newline at end of file diff --git a/packages/tracer/package.json b/packages/tracer/package.json index ae3e2091a9..80dd44fc1f 100644 --- a/packages/tracer/package.json +++ b/packages/tracer/package.json @@ -52,5 +52,12 @@ "dependencies": { "@aws-lambda-powertools/commons": "^0.11.1-rc.0", "aws-xray-sdk-core": "^3.3.6" - } -} + }, + "keywords": [ + "aws", + "lambda", + "powertools", + "tracer", + "tracing" + ] +} \ No newline at end of file From b0619e4b3b0881f41c5d2ad3ef3ee26e19978db4 Mon Sep 17 00:00:00 2001 From: Andrea Amorosi Date: Sat, 25 Jun 2022 13:41:46 +0200 Subject: [PATCH 3/3] chore: added more keywords --- packages/commons/package.json | 4 +++- packages/logger/package.json | 4 +++- packages/metrics/package.json | 4 +++- packages/tracer/package.json | 4 +++- 4 files changed, 12 insertions(+), 4 deletions(-) diff --git a/packages/commons/package.json b/packages/commons/package.json index 7ba06b6d3f..6dbdf621f9 100644 --- a/packages/commons/package.json +++ b/packages/commons/package.json @@ -44,6 +44,8 @@ "keywords": [ "aws", "lambda", - "powertools" + "powertools", + "serverless", + "nodejs" ] } \ No newline at end of file diff --git a/packages/logger/package.json b/packages/logger/package.json index 264e01927c..e41eff7138 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -60,6 +60,8 @@ "lambda", "powertools", "logger", - "logging" + "logging", + "serverless", + "nodejs" ] } \ No newline at end of file diff --git a/packages/metrics/package.json b/packages/metrics/package.json index f6a27c2d35..d80bf77665 100644 --- a/packages/metrics/package.json +++ b/packages/metrics/package.json @@ -55,6 +55,8 @@ "aws", "lambda", "powertools", - "metrics" + "metrics", + "serverless", + "nodejs" ] } \ No newline at end of file diff --git a/packages/tracer/package.json b/packages/tracer/package.json index 80dd44fc1f..743e8ef93d 100644 --- a/packages/tracer/package.json +++ b/packages/tracer/package.json @@ -58,6 +58,8 @@ "lambda", "powertools", "tracer", - "tracing" + "tracing", + "serverless", + "nodejs" ] } \ No newline at end of file