Skip to content

Commit b842d87

Browse files
dreamorosidreamorosi
authored
docs: update docs to reflect RC status (#1009)
* docs: updated docs to reflect RC status * chore: added keywords + removed extra tag from readme * chore: added more keywords
1 parent d0871f7 commit b842d87

File tree

13 files changed

+68
-35
lines changed

13 files changed

+68
-35
lines changed

Diff for: ‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript
22

3-
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
3+
| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>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). |_
5+
| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. <br/>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). |_
66

77
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).
88

Diff for: ‎docs/core/logger.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Logger
33
description: Core utility
44
---
55

6-
!!! warning "Do not use this library in production"
6+
!!! warning "Do not use this library in production (yet)"
77

8-
AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
9-
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"}.
8+
AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
9+
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"}.
1010

11-
**Do not use this library for production workloads.**
11+
**Do not use this library for production workloads (yet).**
1212

1313
Logger provides an opinionated logger with output structured as JSON.
1414

Diff for: ‎docs/core/metrics.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Metrics
33
description: Core utility
44
---
55

6-
!!! warning "Do not use this library in production"
6+
!!! warning "Do not use this library in production (yet)"
77

8-
AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
9-
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"}.
8+
AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
9+
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"}.
1010

11-
**Do not use this library for production workloads.**
11+
**Do not use this library for production workloads (yet).**
1212

1313
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).
1414

Diff for: ‎docs/core/tracer.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Tracer
33
description: Core utility
44
---
55

6-
!!! warning "Do not use this library in production"
6+
!!! warning "Do not use this library in production (yet)"
77

8-
AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
9-
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"}.
8+
AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
9+
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"}.
1010

11-
**Do not use this library for production workloads.**
11+
**Do not use this library for production workloads (yet).**
1212

1313
Tracer is an opinionated thin wrapper for [AWS X-Ray SDK for Node.js](https://github.com/aws/aws-xray-sdk-node).
1414

Diff for: ‎docs/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ title: Homepage
33
description: AWS Lambda Powertools for TypeScript
44
---
55

6-
!!! warning "Do not use this library in production"
6+
!!! warning "Do not use this library in production (yet)"
77

8-
AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only.
9-
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"}.
8+
AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only.
9+
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"}.
1010

11-
**Do not use this library for production workloads.**
11+
**Do not use this library for production workloads (yet).**
1212

1313
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.
1414

Diff for: ‎packages/commons/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript
22

3-
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
3+
| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>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). |_
5+
| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. <br/>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). |_
66

77

88
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).
@@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l
2323

2424
### Installation
2525

26-
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"}.
26+
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).
2727
Each TypeScript utility is installed as standalone NPM package.
2828

2929
👉 [Installation guide for the **Tracer** utility](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer#getting-started)

Diff for: ‎packages/commons/package.json

+9-2
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,12 @@
4040
},
4141
"bugs": {
4242
"url": "https://github.com/awslabs/aws-lambda-powertools-typescript/issues"
43-
}
44-
}
43+
},
44+
"keywords": [
45+
"aws",
46+
"lambda",
47+
"powertools",
48+
"serverless",
49+
"nodejs"
50+
]
51+
}

Diff for: ‎packages/logger/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript
22

3-
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
3+
| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>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). |_
5+
| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. <br/>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). |_
66

77

88
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 for: ‎packages/logger/package.json

+11-2
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,14 @@
5454
"lodash.clonedeep": "^4.5.0",
5555
"lodash.merge": "^4.6.2",
5656
"lodash.pickby": "^4.6.0"
57-
}
58-
}
57+
},
58+
"keywords": [
59+
"aws",
60+
"lambda",
61+
"powertools",
62+
"logger",
63+
"logging",
64+
"serverless",
65+
"nodejs"
66+
]
67+
}

Diff for: ‎packages/metrics/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript
22

3-
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
3+
| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>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). |_
5+
| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. <br/>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). |_
66

77

88
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 for: ‎packages/metrics/package.json

+10-2
Original file line numberDiff line numberDiff line change
@@ -50,5 +50,13 @@
5050
},
5151
"dependencies": {
5252
"@aws-lambda-powertools/commons": "^0.11.1-rc.0"
53-
}
54-
}
53+
},
54+
"keywords": [
55+
"aws",
56+
"lambda",
57+
"powertools",
58+
"metrics",
59+
"serverless",
60+
"nodejs"
61+
]
62+
}

Diff for: ‎packages/tracer/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# AWS Lambda Powertools for TypeScript
22

3-
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
3+
| ⚠️ **WARNING: Do not use this library in production (yet)** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5-
| AWS Lambda Powertools for TypeScript is currently released as a beta developer preview and is intended strictly for feedback purposes only. <br/>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). |_
5+
| AWS Lambda Powertools for TypeScript is currently released as a release candidate (RC) and is intended for feedback and testing purposes only. <br/>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). |_
66

77

88
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 for: ‎packages/tracer/package.json

+11-2
Original file line numberDiff line numberDiff line change
@@ -52,5 +52,14 @@
5252
"dependencies": {
5353
"@aws-lambda-powertools/commons": "^0.11.1-rc.0",
5454
"aws-xray-sdk-core": "^3.3.6"
55-
}
56-
}
55+
},
56+
"keywords": [
57+
"aws",
58+
"lambda",
59+
"powertools",
60+
"tracer",
61+
"tracing",
62+
"serverless",
63+
"nodejs"
64+
]
65+
}

0 commit comments

Comments
 (0)