Skip to content

Docs: fix cleanup command in cdk example #1311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
1 task done
niko-achilles opened this issue Feb 19, 2023 · 4 comments · Fixed by #1364
Closed
1 task done

Docs: fix cleanup command in cdk example #1311

niko-achilles opened this issue Feb 19, 2023 · 4 comments · Fixed by #1364
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing

Comments

@niko-achilles
Copy link
Contributor

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.
@niko-achilles niko-achilles added documentation Improvements or additions to documentation triage This item has not been triaged by a maintainer, please wait labels Feb 19, 2023
@dreamorosi dreamorosi moved this from Ideas to Backlog in AWS Lambda Powertools for TypeScript Feb 19, 2023
@dreamorosi
Copy link
Contributor

dreamorosi commented Feb 20, 2023

Hi Niko, thank you for opening this issue.

We should fix the issue and fix the file. If anyone is interested in opening a PR to do so, please leave a comment below.

Suggested edit:

-- To delete the sample application that you created, run the command below while in the `examples/sam` directory:
++ To delete the sample application that you created, run the command below while in the `examples/cdk` directory:

```bash
-- cdk delete
++ cdk destroy

@dreamorosi dreamorosi added good-first-issue Something that is suitable for those who want to start contributing help-wanted We would really appreciate some support from community for this one and removed triage This item has not been triaged by a maintainer, please wait labels Feb 20, 2023
@dreamorosi dreamorosi changed the title Docs: after completing cdk sample app - deleting cdk sample app Docs: fix cleanup command in cdk example Feb 27, 2023
@Peim8
Copy link
Contributor

Peim8 commented Mar 8, 2023

Can I work on that?

@dreamorosi
Copy link
Contributor

Hey, yes definitely!

I'll assign the issue to you. If you have any question about setting up the repo or other processes, let me know.

@dreamorosi dreamorosi linked a pull request Mar 9, 2023 that will close this issue
13 tasks
@github-project-automation github-project-automation bot moved this from Backlog to Coming soon in AWS Lambda Powertools for TypeScript Mar 9, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 9, 2023

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript Mar 9, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed help-wanted We would really appreciate some support from community for this one labels Mar 9, 2023
@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label Mar 9, 2023
@dreamorosi dreamorosi removed the pending-release This item has been merged and will be released soon label Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants