Skip to content

Commit b1997af

Browse files
author
Michael Brewer
authored
docs: Tracer example link goes to a 404 (#414)
* 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: fix more lint errors and links * docs: fix more lint errors and link
1 parent 471eaca commit b1997af

File tree

6 files changed

+18
-30
lines changed

6 files changed

+18
-30
lines changed

Diff for: ‎README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Lambda Powertools TypeScript
1+
# AWS Lambda Powertools (TypeScript)
22

33
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p
1111

1212
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1313
14-
### Features
14+
## Features
1515

1616
* **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
1717
* **[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
1818
* **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
1919

20-
2120
## Getting started
2221

2322
Find the complete project's [documentation here](https://awslabs.github.io/aws-lambda-powertools-typescript).
@@ -36,20 +35,19 @@ Each TypeScript utility is installed as standalone NPM package.
3635
### Examples
3736

3837
* [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk)
39-
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/tracing/examples)
38+
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib)
4039
* [Logger](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/logger/examples)
4140
* [Metrics](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics/examples)
4241

4342
## Credits
4443

4544
* 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/).
4645

47-
4846
## Connect
4947

50-
* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
48+
* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
5149
* **Email**: [email protected]
5250

5351
## License
5452

55-
This library is licensed under the MIT-0 License. See the LICENSE file.
53+
This library is licensed under the MIT-0 License. See the LICENSE file.

Diff for: ‎docs/index.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Each TypeScript utility is installed as standalone NPM package.
4545

4646
[Installation guide for the **Metrics** utility](./core/metrics.md#getting-started)
4747

48-
4948
## Environment variables
5049

5150
!!! info
@@ -63,19 +62,17 @@ Each TypeScript utility is installed as standalone NPM package.
6362
| **POWERTOOLS_LOG_DEDUPLICATION_DISABLED** | Disables log deduplication filter protection to use Pytest Live Log feature | [Logger](./core/logger) | `false` |
6463
| **LOG_LEVEL** | Sets logging level | [Logger](./core/logger) | `INFO` |
6564

66-
6765
## Examples
6866

6967
* [CDK](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk){target="_blank"}
70-
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/tracing/examples){target="_blank"}
68+
* [Tracer](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk/lib){target="_blank"}
7169
* [Logger](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/logger/examples){target="_blank"}
7270
* [Metrics](https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/packages/metrics/examples){target="_blank"}
7371

7472
## Credits
7573

7674
* 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"}.
7775

78-
7976
## Connect
8077

8178
* **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"}

Diff for: ‎packages/commons/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Lambda Powertools TypeScript
1+
# AWS Lambda Powertools (TypeScript)
22

33
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p
1111

1212
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1313
14-
### Features
14+
## Features
1515

1616
* **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
1717
* **[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
1818
* **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
1919

20-
2120
## Getting started
2221

2322
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.
4443

4544
* 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/).
4645

47-
4846
## Connect
4947

50-
* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
48+
* **AWS Developers Slack**: `#lambda-powertools`- **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
5149
* **Email**: [email protected]
5250

5351
## License

Diff for: ‎packages/logger/README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Lambda Powertools TypeScript
1+
# AWS Lambda Powertools (TypeScript)
22

33
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -11,7 +11,7 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p
1111

1212
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1313
14-
### Features
14+
## Features
1515

1616
* **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
1717
* **[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.
4444

4545
* 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/).
4646

47-
4847
## Connect
4948

50-
* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
49+
* **AWS Developers Slack**: `#lambda-powertools`- **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
5150
* **Email**: [email protected]
5251

5352
## License

Diff for: ‎packages/metrics/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Lambda Powertools TypeScript
1+
# AWS Lambda Powertools (TypeScript)
22

33
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p
1111

1212
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1313
14-
### Features
14+
## Features
1515

1616
* **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
1717
* **[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
1818
* **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
1919

20-
2120
## Getting started
2221

2322
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.
4443

4544
* 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/).
4645

47-
4846
## Connect
4947

50-
* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
48+
* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
5149
* **Email**: [email protected]
5250

5351
## License

Diff for: ‎packages/tracing/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AWS Lambda Powertools TypeScript
1+
# AWS Lambda Powertools (TypeScript)
22

33
| ⚠️ **WARNING: Do not use this library in production** ⚠️ |
44
|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -11,13 +11,12 @@ A suite of TypeScript utilities for AWS Lambda functions to ease adopting best p
1111

1212
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1313
14-
### Features
14+
## Features
1515

1616
* **[Tracer](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
1717
* **[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
1818
* **[Metrics](https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
1919

20-
2120
## Getting started
2221

2322
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.
4443

4544
* 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/).
4645

47-
4846
## Connect
4947

50-
* **AWS Developers Slack**: `#lambda-powertools`** - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
48+
* **AWS Developers Slack**: `#lambda-powertools` - **[Invite, if you don't have an account](https://join.slack.com/t/awsdevelopers/shared_invite/zt-yryddays-C9fkWrmguDv0h2EEDzCqvw)**
5149
* **Email**: [email protected]
5250

5351
## License

0 commit comments

Comments
 (0)