Skip to content

Docs: review batch docs & readme #2319

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
1 task done
dreamorosi opened this issue Apr 5, 2024 · 2 comments · Fixed by #2320
Closed
1 task done

Docs: review batch docs & readme #2319

dreamorosi opened this issue Apr 5, 2024 · 2 comments · Fixed by #2320
Assignees
@dreamorosi
Labels
batch This item relates to the Batch Processing Utility completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@dreamorosi
Copy link
Contributor

What were you searching in the docs?

Some of the syntax highlights in the Batch docs are broken and one of the sections is needlessly wrapped in a tooltip.

Additionally, the README for the utility contains a broken link to the Lambda Layers and has an code snippet that could be updated to use fetch instead.

Is this related to an existing documentation section?

No response

How can we improve?

Review both docs & correct the issues described above.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@dreamorosi dreamorosi added documentation Improvements or additions to documentation confirmed The scope is clear, ready for implementation batch This item relates to the Batch Processing Utility labels Apr 5, 2024
@dreamorosi dreamorosi self-assigned this Apr 5, 2024
@dreamorosi dreamorosi moved this from Triage to Pending review in Powertools for AWS Lambda (TypeScript) Apr 5, 2024
@dreamorosi dreamorosi mentioned this issue Apr 5, 2024
Merged
9 tasks
@dreamorosi dreamorosi linked a pull request Apr 5, 2024 that will close this issue
chore(docs): update batch docs highlight & links #2320
Merged
9 tasks
@github-project-automation github-project-automation bot moved this from Pending review to Coming soon in Powertools for AWS Lambda (TypeScript) Apr 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 5, 2024

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments 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 pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels Apr 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

This is now released under v2.0.4 version!

@github-actions github-actions bot 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 labels Apr 10, 2024
@dreamorosi dreamorosi moved this from Coming soon to Shipped in Powertools for AWS Lambda (TypeScript) Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dreamorosi dreamorosi

Labels
batch This item relates to the Batch Processing Utility completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
Powertools for AWS Lambda (TypeScript)
Status: Shipped
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): update batch docs highlight & links aws-powertools/powertools-lambda-typescript
1 participant
@dreamorosi