Skip to content
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

docs: Improve examples/cdk/README.md #467

Merged
merged 3 commits into from
Jan 17, 2022
Merged

Conversation

alex-m-aws
Copy link
Contributor

Description of your changes

Write a dedicated readme that explains how to deploy and interact with the CDK examples. Also update stack identifiers, e.g. CdkAppStack, to more specific ones, e.g. 'LambdaPowertoolsTypeScript-ExamplesCdkStack', to consider users that are deploying this stack amongst others into their accounts.

The current README is just the default CDK TS readme and is therefore not helpful.

No dependencies for this change.

How to verify this change

Related issues, RFCs

#XXXXX
#ZZZZZ

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

Breaking change checklist

N/A


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 14, 2022
examples/cdk/README.md Outdated Show resolved Hide resolved
examples/cdk/README.md Outdated Show resolved Hide resolved
examples/cdk/README.md Show resolved Hide resolved
examples/cdk/README.md Outdated Show resolved Hide resolved
examples/cdk/README.md Outdated Show resolved Hide resolved
packages/metrics/tests/e2e/decorator.test.MyFunction.ts Outdated Show resolved Hide resolved
@alex-m-aws
Copy link
Contributor Author

alex-m-aws commented Jan 14, 2022

@dreamorosi comments addressed in bd217ef

examples/cdk/README.md Outdated Show resolved Hide resolved
@dreamorosi dreamorosi merged commit 646a9e8 into main Jan 17, 2022
@dreamorosi dreamorosi deleted the docs/cdk-example-readme branch January 17, 2022 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants