Skip to content

Docs: write utility readme & update main one #1042

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.

Sign up for GitHub

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

Jump to bottom
Closed
dreamorosi opened this issue Aug 4, 2022 · 1 comment · Fixed by #1280
Closed

Docs: write utility readme & update main one #1042

dreamorosi opened this issue Aug 4, 2022 · 1 comment · Fixed by #1280
Assignees
@dreamorosi
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility
Milestone
Parameters - Beta...

Comments

@dreamorosi
Copy link
Contributor

Description of the improvement

Summary of the proposal
As a part of the implementation of the utility it's necessary to have a dedicated readme file for the utility as well as update the main one in the root of the project.

The first one will be also used in the npm page, the latter will need to be updated to mention the new utility.

How, where did you look for information
Readme of both root and package.

Missing or unclear documentation
Info about the utility.

Improvement
N/A

Related existing documentation

N/A

Related issues, RFCs

#846
@dreamorosi dreamorosi added documentation Improvements or additions to documentation triage This item has not been triaged by a maintainer, please wait parameters This item relates to the Parameters Utility labels Aug 4, 2022
@dreamorosi dreamorosi added this to the Parameters milestone Aug 4, 2022
@dreamorosi dreamorosi added on-hold This item is on-hold and will be revisited in the future and removed triage This item has not been triaged by a maintainer, please wait labels Nov 13, 2022
@dreamorosi dreamorosi moved this from On hold to Backlog in AWS Lambda Powertools for TypeScript Nov 13, 2022
@dreamorosi dreamorosi changed the title Documentation (parameters): write utility readme & update main one Docs: write utility readme & update main one Nov 14, 2022
@dreamorosi dreamorosi mentioned this issue Feb 8, 2023
Closed
@dreamorosi dreamorosi self-assigned this Feb 8, 2023
@dreamorosi dreamorosi moved this from Backlog to Pending review in AWS Lambda Powertools for TypeScript Feb 8, 2023
@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation and removed on-hold This item is on-hold and will be revisited in the future labels Feb 8, 2023
@dreamorosi dreamorosi mentioned this issue Feb 8, 2023
Merged
13 tasks
@dreamorosi dreamorosi linked a pull request Feb 8, 2023 that will close this issue
docs(parameters): write utility readme update main one #1280
Merged
13 tasks
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in AWS Lambda Powertools for TypeScript Mar 20, 2023
@github-actions
Copy link
Contributor

⚠️ 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.

@github-actions github-actions bot added the pending-release This item has been merged and will be released soon label Mar 20, 2023
@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon confirmed The scope is clear, ready for implementation labels Mar 20, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript Mar 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation parameters This item relates to the Parameters Utility
Projects
None yet
Milestone
Parameters - Beta release
Development

Successfully merging a pull request may close this issue.

docs(parameters): write utility readme update main one aws-powertools/powertools-lambda-typescript
1 participant
@dreamorosi