Skip to content

Conversation

@saragerion
Copy link
Contributor

@saragerion saragerion commented Dec 27, 2021

Description of your changes

  • Added readme files with minimal content for each package (including root)
  • Added installation guide
  • Added notice/warning about beta and unstable version
  • Added third party licenses notice

How to verify this change

Readme files:
https://github.com/awslabs/aws-lambda-powertools-typescript/blob/ba37617b4d5ea2622e726c2c3541c904e52d13dc/README.md

MKDOCS: see local buid.

Related issues, RFCs

#349

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.

@saragerion saragerion linked an issue Dec 27, 2021 that may be closed by this pull request
@dreamorosi dreamorosi added all documentation Improvements or additions to documentation labels Dec 27, 2021
@dreamorosi
Copy link
Contributor

Intro + disclaimers on the documentation look great :)

@saragerion saragerion marked this pull request as ready for review December 27, 2021 18:42

## Credits

* Structured logging initial implementation from [aws-lambda-logging](https://gitlab.com/hadrien/aws_lambda_logging)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed this one because I realized it was a python library

@dreamorosi dreamorosi added this to the beta-release milestone Dec 28, 2021
@saragerion saragerion merged commit 096037a into main Dec 28, 2021
@saragerion saragerion deleted the feat/readme branch December 28, 2021 10:13
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: README files, beta release warnings

4 participants