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: update docs to reflect RC status #1009

Conversation

dreamorosi
Copy link
Contributor

@dreamorosi dreamorosi commented Jun 24, 2022

Description of your changes

As discussed in #1008, the project has now reached the Release Candidate stage. As such I am updating the note at the top of the README files and documentation to reflect the change.

Please let me know if you agree with the wording used, if so, once the PR is merged it will close #1008.

How to verify this change

See screenshot below:

Screenshot 2022-06-24 at 19 53 09

Related issues, RFCs

#1008

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 made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • New and existing unit tests pass locally and in Github Actions
  • 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.

@dreamorosi dreamorosi self-assigned this Jun 24, 2022
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 24, 2022
@dreamorosi dreamorosi requested review from flochaz and saragerion June 24, 2022 17:54
@github-actions
Copy link
Contributor

github-actions bot commented Jun 24, 2022

📊 Package size report   0.2%↑

File Before After
aws-lambda-powertools-commons-0.11.1-rc.0.tgz 6.5 kB 0.3%↑6.5 kB
aws-lambda-powertools-logger-0.11.1-rc.0.tgz 23.7 kB 0.09%↑23.7 kB
aws-lambda-powertools-metrics-0.11.1-rc.0.tgz 17.5 kB 0.1%↑17.5 kB
aws-lambda-powertools-tracer-0.11.1-rc.0.tgz 21.4 kB 0.1%↑21.4 kB
commons-bundle.zip 7.1 kB 0.2%↑7.1 kB
logger-bundle.zip 24.2 kB 0.1%↑24.2 kB
metrics-bundle.zip 17.9 kB 0.5%↑18.0 kB
tracer-bundle.zip 21.9 kB 0.1%↑22.0 kB
Total (Includes all files) 140.2 kB 0.2%↑140.5 kB
Tarball size 138.9 kB 0.2%↑139.3 kB

🤖 This report was automatically generated by pkg-size-action
(options hash: 54a2e9c56be4f0ea9bc83ee45dcf2d04)

saragerion
saragerion previously approved these changes Jun 24, 2022
@dreamorosi
Copy link
Contributor Author

Removed extra tag from the readme file of the commons package because it rendered weirdly on npmjs.com:

image

@dreamorosi
Copy link
Contributor Author

I also added some keywords to each package.json file using the same from the GH repository, this should help with discoverability.

I realised that they were missing because on npmjs the section is empty and we don't show up in the autocomplete unless you specifically search for aws-lambda-powertools*:

image

@dreamorosi dreamorosi requested a review from saragerion June 25, 2022 11:44
@github-actions
Copy link
Contributor

github-actions bot commented Jun 25, 2022

📊 Package size report   0.4%↑

File Before After
aws-lambda-powertools-commons-0.11.1-rc.0.tgz 6.5 kB 0.5%↑6.5 kB
aws-lambda-powertools-logger-0.11.1-rc.0.tgz 23.7 kB 0.3%↑23.8 kB
aws-lambda-powertools-metrics-0.11.1-rc.0.tgz 17.5 kB 0.3%↑17.5 kB
aws-lambda-powertools-tracer-0.11.1-rc.0.tgz 21.4 kB 0.3%↑21.5 kB
commons-bundle.zip 7.1 kB 0.5%↑7.1 kB
logger-bundle.zip 24.2 kB 0.5%↑24.3 kB
metrics-bundle.zip 17.9 kB 0.7%↑18.1 kB
tracer-bundle.zip 21.9 kB 0.1%↑22.0 kB
Total (Includes all files) 140.2 kB 0.4%↑140.7 kB
Tarball size 139.0 kB 0.4%↑139.6 kB

🤖 This report was automatically generated by pkg-size-action
(options hash: f880679e351e52758e40910d57deb520)

@dreamorosi dreamorosi merged commit b842d87 into main Jun 27, 2022
@dreamorosi dreamorosi deleted the 1008-documentation-all-update-readme-files-docs-to-reflect-rc-status branch June 27, 2022 16:30
dreamorosi added a commit that referenced this pull request Aug 2, 2022
* docs: updated docs to reflect RC status

* chore: added keywords + removed extra tag from readme

* chore: added more keywords
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.

Docs: update README files & docs to reflect RC status
3 participants