Skip to content

Docs: clarify Middy's role #359

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

Closed
heitorlessa opened this issue Dec 28, 2021 · 1 comment · Fixed by #370
Closed

Docs: clarify Middy's role #359

heitorlessa opened this issue Dec 28, 2021 · 1 comment · Fixed by #370
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation tracer This item relates to the Tracer Utility
Milestone

Comments

@heitorlessa
Copy link
Contributor

Description of the improvement

Summary of the proposal

Clarify whether customers need to install Middy and what its role is before sharing code snippets.

How, where did you look for information

Tracer page when looking to how to use it.

Missing or unclear documentation

The first example of Tracer make use of Middy to showcase how to use it as a middleware - This however might not be known to everyone first-hand, and this also requires them to install another dependency in order to use Powertools Tracer.

Improvement

If Middy is the preferred way throughout the docs (Middy, then Decorator, then Manual), make an explicit mention as to what Middy is, its role when using Powertools and whether it's required to follow the example.

Related existing documentation

A related issue is what seems to be an incorrect line number to highlight - I suspect you meant L10.

image

Related issues, RFCs

@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Dec 28, 2021
@saragerion saragerion added the tracer This item relates to the Tracer Utility label Dec 28, 2021
@dreamorosi dreamorosi self-assigned this Dec 29, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 29, 2021
@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.

@dreamorosi dreamorosi changed the title Tracer: Clarify Middy's role Docs: clarify Middy's role Nov 14, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation tracer This item relates to the Tracer Utility
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants