Skip to content

Docs: fix cleanup command in cdk example #1311

Closed
@niko-achilles

Description

@niko-achilles

What were you searching in the docs?

Example with cdk, sample application .
Location: https://github.com/awslabs/aws-lambda-powertools-typescript/tree/main/examples/cdk

Is this related to an existing documentation section?

https://github.com/awslabs/aws-lambda-powertools-typescript/blob/fa236b94b6532685588edd2f440c911dc6de56ab/examples/cdk/README.md?plain=1#L75

How can we improve?

The instruction on how to delete the sample application is described as follows:  
To delete the sample application that you created, run the command below while in the `examples/sam` directory:

cdk delete

Thoughts:
- The location to run the command is accidently wrong (`examples/sam`) 
- The command to delete is accidently wrong (`cdk delete`)

Got a suggestion in mind?

The proposed update is to correct where (location) to run the command for deleting sample cdk app and the command that should be used deleting (how).
E.g: in cdk the word destroy is used, cdk destroy, npx cdk --destroy

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.

Metadata

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationgood-first-issueSomething that is suitable for those who want to start contributing

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions