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: updated project names to aws lambda power tools for typescript #628

Merged
merged 6 commits into from
Mar 8, 2022

Conversation

goverdhan07
Copy link
Contributor

@goverdhan07 goverdhan07 commented Mar 4, 2022

Description of your changes

  • updated project names to AWS Lambda Power tools for TypeScript

How to verify this change

Related issues, RFCs

#624

#624
#ZZZZZ

PR status

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

Checklist

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

Breaking change checklist

  • I have documented the migration process
  • I have added, implemented necessary warnings (if it can live side by side)

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 Mar 5, 2022
@dreamorosi
Copy link
Contributor

Hi @goverdhan07 thanks for the PR, will review it early next week.

We really appreciate you taking the time to open a PR, next time could you please leave a comment under the issue you've referenced before start working, like asked in the Contributing guidelines?

@dreamorosi dreamorosi requested review from dreamorosi and ijemmy March 5, 2022 15:14
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you again for the PR, it's already looking good, just one minor note:

The various README.md files (both in the proejct root & in the packages roots i.e. packages/logger/README.md) also mention the existence of Powertools for other runtimes - example. Could you please apply the same naming to that line - i.e. AWS Lambda Powertools for Python, etc.?

I'm going to request a review from a second maintainer so that when we have 2 approvals we can merge it.

Note for other reviewers: There is an occurrence of the name that appears mid document here and that hasn't been updated, I think it should stay as it is as it falls under the usage described here.

@dreamorosi dreamorosi requested a review from saragerion March 7, 2022 09:28
flochaz
flochaz previously approved these changes Mar 7, 2022
dreamorosi
dreamorosi previously approved these changes Mar 8, 2022
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks for the PR!

dreamorosi
dreamorosi previously approved these changes Mar 8, 2022
Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this PR :)

Minor change needed, otherwise looks good.

@@ -23,7 +23,7 @@ Find the complete project's [documentation here](https://awslabs.github.io/aws-l

### Installation

The AWS Lambda Powertools TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).
The AWS AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The AWS AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).
The AWS Lambda Powertools for TypeScript utilities follow a modular approach, similar to the official [AWS SDK v3 for JavaScript](https://github.com/aws/aws-sdk-js-v3).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated :)

Copy link
Contributor

@saragerion saragerion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@dreamorosi dreamorosi self-requested a review March 8, 2022 13:57
@dreamorosi dreamorosi merged commit b19e834 into aws-powertools:main Mar 8, 2022
@dreamorosi dreamorosi mentioned this pull request Mar 8, 2022
5 tasks
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.

Maintenance: change project name to "AWS Lambda Powertools for TypeScript"
4 participants