Skip to content

Commit f33c4c5

Browse files
dreamorosidreamorosi
authored
chore(docs): update docs url in comments & readme files (#1728)
1 parent cd46f5a commit f33c4c5

34 files changed

+122
-123
lines changed

Diff for: ‎.github/ISSUE_TEMPLATE/feature_request.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ body:
3535
attributes:
3636
label: Acknowledgment
3737
options:
38-
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda-typescript/latest/#tenets)
38+
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets)
3939
required: true
4040
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [Java](https://github.com/aws-powertools/powertools-lambda-java/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/)
4141
required: false

Diff for: ‎.github/ISSUE_TEMPLATE/maintenance.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ body:
5353
attributes:
5454
label: Acknowledgment
5555
options:
56-
- label: This request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda-typescript/latest/#tenets)
56+
- label: This request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets)
5757
required: true
5858
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [Java](https://github.com/aws-powertools/powertools-lambda-java/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/)
5959
required: false

Diff for: ‎.github/ISSUE_TEMPLATE/rfc.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ body:
8686
attributes:
8787
label: Acknowledgment
8888
options:
89-
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda-typescript/latest/#tenets)
89+
- label: This feature request meets [Powertools for AWS Lambda (TypeScript) Tenets](https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets)
9090
required: true
9191
- label: Should this be considered in other Powertools for AWS Lambda languages? i.e. [Python](https://github.com/aws-powertools/powertools-lambda-python/), [Java](https://github.com/aws-powertools/powertools-lambda-java/), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet/)
9292
required: false

Diff for: ‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Note: If no issue is present the PR might get blocked and not be reviewed.
2828

2929
## Checklist
3030

31-
- [ ] [My changes meet the tenets criteria](https://docs.powertools.aws.dev/lambda-typescript/#tenets)
31+
- [ ] [My changes meet the tenets criteria](https://docs.powertools.aws.dev/lambda/typescript/#tenets)
3232
- [ ] I have performed a *self-review* of my own code
3333
- [ ] I have *commented* my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
3434
- [ ] I have made corresponding changes to the *documentation*

Diff for: ‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ get to soon while `priority:high` issues have a bigger impact, so we are much mo
7878

7979
### Step 2: Design
8080

81-
You can start by checking the project's tenets [here](https://docs.powertools.aws.dev/lambda-typescript/latest/#tenets).
81+
You can start by checking the project's tenets [here](https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets).
8282

8383
We ask you to seek feedback and consensus on your proposed change by iterating on a design document. This is especially useful when you plan a big change or feature, or you want advice on what would be the best path forward.
8484

Diff for: ‎MAINTAINERS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ This allows you to have control over the commit message although it should match
154154

155155
Manage [labels](#labels), review issues regularly, and create new labels as needed by the project. Remove `triage` label when you're able to confirm the validity of a request, a bug can be reproduced, etc. Give priority to the original author for implementation, unless it is a sensitive task that is best handled by maintainers.
156156

157-
Make sure issues are assigned to our [board of activities](https://github.com/orgs/aws-powertools/projects/7) and have the right [status](https://docs.powertools.aws.dev/lambda-typescript/latest/roadmap/#roadmap-status-definition).
157+
Make sure issues are assigned to our [board of activities](https://github.com/orgs/aws-powertools/projects/7) and have the right [status](https://docs.powertools.aws.dev/lambda/typescript/latest/roadmap/#roadmap-status-definition).
158158

159159
Use our [labels](#labels) to signal good first issues to new community members, and to set expectation that this might need additional feedback from the author, other customers, experienced community members and/or maintainers.
160160

@@ -179,7 +179,7 @@ RFC is a collaborative process to help us get to the most optimal solution given
179179
Make sure you ask these questions in mind when reviewing:
180180

181181
- Does it use our [RFC template](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=RFC%2Ctriage&template=rfc.yml&title=RFC%3A+TITLE)?
182-
- Does the match our [Tenets](https://docs.powertools.aws.dev/lambda-typescript/latest/#tenets)?
182+
- Does the match our [Tenets](https://docs.powertools.aws.dev/lambda/typescript/latest/#tenets)?
183183
- Does the proposal address the use case? If so, is the recommended usage explicit?
184184
- Does it focus on the mechanics to solve the use case over fine-grained implementation details?
185185
- Can anyone familiar with the code base implement it?
@@ -239,7 +239,7 @@ Keep the `main` branch at production quality at all times. If a PR introduces co
239239

240240
### Manage Roadmap
241241

242-
See [Roadmap section](https://docs.powertools.aws.dev/lambda-typescript/latest/roadmap/)
242+
See [Roadmap section](https://docs.powertools.aws.dev/lambda/typescript/latest/roadmap/)
243243

244244
Ensure the repo highlights features that should be elevated to the project roadmap. Be clear about the feature’s status, priority, target version, and whether or not it should be elevated to the roadmap.
245245

Diff for: ‎README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
[![Join our Discord](https://dcbadge.vercel.app/api/server/B8zZKbbyET)](https://discord.gg/B8zZKbbyET)
44

5-
Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda-typescript/latest/#features).
5+
Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features).
66

77
You can use the library in both TypeScript and JavaScript code bases.
88

9-
> Also available in [Python](https://github.com/aws-powertools/powertools-lambda-python), [Java](https://github.com/aws-powertools/powertools-lambda-java), and [.NET](https://docs.powertools.aws.dev/lambda-dotnet/).
9+
> Also available in [Python](https://github.com/aws-powertools/powertools-lambda-python), [Java](https://github.com/aws-powertools/powertools-lambda-java), and [.NET](https://github.com/aws-powertools/powertools-lambda-dotnet).
1010
11-
**[Documentation](https://docs.powertools.aws.dev/lambda-typescript/)** | **[npm](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://docs.powertools.aws.dev/lambda-typescript/latest/roadmap)** | **[Examples](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples)** | **[Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo)**
11+
**[Documentation](https://docs.powertools.aws.dev/lambda/typescript/)** | **[npm](https://www.npmjs.com/org/aws-lambda-powertools)** | **[Roadmap](https://docs.powertools.aws.dev/lambda/typescript/latest/roadmap)** | **[Examples](https://github.com/aws-powertools/powertools-lambda-typescript/tree/main/examples)** | **[Serverless TypeScript Demo](https://github.com/aws-samples/serverless-typescript-demo)**
1212

1313
## Table of contents <!-- omit in toc -->
1414

@@ -31,16 +31,16 @@ You can use the library in both TypeScript and JavaScript code bases.
3131

3232
## Features
3333

34-
* **[Tracer](https://docs.powertools.aws.dev/lambda-typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
35-
* **[Logger](https://docs.powertools.aws.dev/lambda-typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context
36-
* **[Metrics](https://docs.powertools.aws.dev/lambda-typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
37-
* **[Parameters](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB
38-
* **[Idempotency](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content
39-
* **[Batch Processing](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams.
34+
* **[Tracer](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer/)** - Utilities to trace Lambda function handlers, and both synchronous and asynchronous functions
35+
* **[Logger](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger/)** - Structured logging made easier, and a middleware to enrich log items with key details of the Lambda context
36+
* **[Metrics](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics/)** - Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF)
37+
* **[Parameters](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/)** - High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB
38+
* **[Idempotency](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/)** - Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content
39+
* **[Batch Processing](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/batch/)** - Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams.
4040

4141
## Getting started
4242

43-
Find the complete project's [documentation here](https://docs.powertools.aws.dev/lambda-typescript).
43+
Find the complete project's [documentation here](https://docs.powertools.aws.dev/lambda/typescript).
4444

4545
### Installation
4646

@@ -52,7 +52,7 @@ You have 2 ways of consuming those utilities:
5252

5353
The Powertools for AWS Lambda (TypeScript) utilities is packaged as a single [AWS Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-concepts.html#gettingstarted-concepts-layer)
5454

55-
👉 [Installation guide for the **Powertools for AWS Lambda (TypeScript)** layer](https://docs.powertools.aws.dev/lambda-typescript/latest/#lambda-layer)
55+
👉 [Installation guide for the **Powertools for AWS Lambda (TypeScript)** layer](https://docs.powertools.aws.dev/lambda/typescript/latest/#lambda-layer)
5656

5757
#### NPM modules
5858

@@ -67,15 +67,15 @@ npm install @aws-lambda-powertools/logger @aws-lambda-powertools/tracer @aws-lam
6767

6868
Or refer to the installation guide of each utility:
6969

70-
👉 [Installation guide for the **Tracer** utility](https://docs.powertools.aws.dev/lambda-typescript/latest/core/tracer#getting-started)
70+
👉 [Installation guide for the **Tracer** utility](https://docs.powertools.aws.dev/lambda/typescript/latest/core/tracer#getting-started)
7171

72-
👉 [Installation guide for the **Logger** utility](https://docs.powertools.aws.dev/lambda-typescript/latest/core/logger#getting-started)
72+
👉 [Installation guide for the **Logger** utility](https://docs.powertools.aws.dev/lambda/typescript/latest/core/logger#getting-started)
7373

74-
👉 [Installation guide for the **Metrics** utility](https://docs.powertools.aws.dev/lambda-typescript/latest/core/metrics#getting-started)
74+
👉 [Installation guide for the **Metrics** utility](https://docs.powertools.aws.dev/lambda/typescript/latest/core/metrics#getting-started)
7575

76-
👉 [Installation guide for the **Parameters** utility](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/parameters/#getting-started)
76+
👉 [Installation guide for the **Parameters** utility](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/parameters/#getting-started)
7777

78-
👉 [Installation guide for the **Idempotency** utility](https://docs.powertools.aws.dev/lambda-typescript/latest/utilities/idempotency/#getting-started)
78+
👉 [Installation guide for the **Idempotency** utility](https://docs.powertools.aws.dev/lambda/typescript/latest/utilities/idempotency/#getting-started)
7979

8080
### Examples
8181

@@ -121,7 +121,7 @@ The following companies, among others, use Powertools:
121121

122122
### Sharing your work
123123

124-
Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://docs.powertools.aws.dev/lambda-typescript/latest/we_made_this).
124+
Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://docs.powertools.aws.dev/lambda/typescript/latest/we_made_this).
125125

126126
### Using Lambda Layer
127127

Diff for: ‎docs/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serve
88
You can use Powertools for AWS Lambda (TypeScript) in both TypeScript and JavaScript code bases.
99

1010
???+ tip
11-
Powertools for AWS Lambda is also available for [Python](https://docs.powertools.aws.dev/lambda-python/){target="_blank"}, [Java](https://docs.powertools.aws.dev/lambda-java/){target="_blank"}, and [.NET](https://docs.powertools.aws.dev/lambda-dotnet/){target="_blank"}
11+
Powertools for AWS Lambda is also available for [Python](https://docs.powertools.aws.dev/lambda/python/){target="_blank"}, [Java](https://docs.powertools.aws.dev/lambda/java/){target="_blank"}, and [.NET](https://docs.powertools.aws.dev/lambda/dotnet/){target="_blank"}
1212

1313
??? hint "Support this project by becoming a reference customer, sharing your work, or using Layers :heart:"
1414

@@ -283,13 +283,13 @@ If instead you want to see Powertools for AWS Lambda (TypeScript) in a slightly
283283
Core utilities such as Tracing, Logging, and Metrics will be available across all Powertools for AWS Lambda languages. Additional utilities are subjective to each language ecosystem and customer demand.
284284

285285
| Utility | Description |
286-
|-------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
286+
| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
287287
| [Tracer](./core/tracer.md) | Decorators and utilities to trace Lambda function handlers, and both synchronous and asynchronous functions |
288288
| [Logger](./core/logger.md) | Structured logging made easier, and a middleware to enrich structured logging with key Lambda context details |
289289
| [Metrics](./core/metrics.md) | Custom Metrics created asynchronously via CloudWatch Embedded Metric Format (EMF) |
290290
| [Parameters](./utilities/parameters.md) | High-level functions to retrieve one or more parameters from AWS SSM Parameter Store, AWS Secrets Manager, AWS AppConfig, and Amazon DynamoDB |
291291
| [Idempotency](./utilities/idempotency.md) | Class method decorator, Middy middleware, and function wrapper to make your Lambda functions idempotent and prevent duplicate execution based on payload content. |
292-
| [Batch Processing](./utilities/batch.md) | Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. |
292+
| [Batch Processing](./utilities/batch.md) | Utility to handle partial failures when processing batches from Amazon SQS, Amazon Kinesis Data Streams, and Amazon DynamoDB Streams. |
293293

294294
## Environment variables
295295

Diff for: ‎examples/cdk/functions/get-all-items.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { logger, metrics, tracer } from './common/powertools';
1818
* This example uses the Middy middleware instrumentation.
1919
* It is the best choice if your existing code base relies on the Middy middleware engine.
2020
* Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless.
21-
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda-typescript/
21+
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda/typescript/
2222
*
2323
* Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
2424
* @param {Object} event - API Gateway Lambda Proxy Input Format

Diff for: ‎examples/cdk/functions/get-by-id.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { logger, metrics, tracer } from './common/powertools';
1515
* This example uses the Method decorator instrumentation.
1616
* Use TypeScript method decorators if you prefer writing your business logic using TypeScript Classes.
1717
* If you aren’t using Classes, this requires the most significant refactoring.
18-
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda-typescript/
18+
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda/typescript/
1919
*
2020
* Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
2121
* @param {APIGatewayProxyEvent} event - API Gateway Lambda Proxy Input Format

Diff for: ‎examples/sam/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Metadata:
184184
EntryPoints:
185185
```
186186

187-
Learn more about Lambda Layers [here](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) and about the Powertools for AWS Lambda (TypeScript) layers [here](https://docs.powertools.aws.dev/lambda-typescript/latest/#lambda-layer).
187+
Learn more about Lambda Layers [here](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) and about the Powertools for AWS Lambda (TypeScript) layers [here](https://docs.powertools.aws.dev/lambda/typescript/latest/#lambda-layer).
188188

189189
## Cleanup
190190

Diff for: ‎examples/sam/src/get-all-items.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { getUuid } from './common/getUuid';
1818
* This example uses the Middy middleware instrumentation.
1919
* It is the best choice if your existing code base relies on the Middy middleware engine.
2020
* Powertools for AWS Lambda (TypeScript) offers compatible Middy middleware to make this integration seamless.
21-
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda-typescript/
21+
* Find more Information in the docs: https://docs.powertools.aws.dev/lambda/typescript/
2222
*
2323
* Event doc: https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
2424
* @param {Object} event - API Gateway Lambda Proxy Input Format

0 commit comments

Comments
 (0)