Skip to content

Documentation: incorrect formatting of alert block #1121

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
dreamorosi opened this issue Oct 17, 2022 · 2 comments · Fixed by #1122
Closed

Documentation: incorrect formatting of alert block #1121

dreamorosi opened this issue Oct 17, 2022 · 2 comments · Fixed by #1122
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation good-first-issue Something that is suitable for those who want to start contributing logger This item relates to the Logger Utility

Comments

@dreamorosi
Copy link
Contributor

Description of the improvement

Summary of the proposal

The documentation for Logger has an alert block that is being rendered incorrectly, most probably due to incorrect formatting of the underlying code:

Screenshot 2022-10-17 at 13 01 10

Opening this issue to track the small effort to fix this in a future PR.

How, where did you look for information

N/A

Missing or unclear documentation

N/A

Improvement

The alert block should look like this but with alert (yellow) formatting:

image

Related existing documentation

https://awslabs.github.io/aws-lambda-powertools-typescript/dev/core/logger/#log-incoming-event

Related issues, RFCs

N/A

@dreamorosi dreamorosi added the documentation Improvements or additions to documentation label Oct 17, 2022
@dreamorosi
Copy link
Contributor Author

Adding the good-first-issue label.

If anyone from the community is interested in taking this issue, please leave a comment below before opening a PR.

Thanks!

@dreamorosi dreamorosi added the good-first-issue Something that is suitable for those who want to start contributing label Oct 17, 2022
@dreamorosi dreamorosi self-assigned this Oct 17, 2022
@dreamorosi dreamorosi linked a pull request Oct 17, 2022 that will close this issue
11 tasks
@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 Oct 17, 2022
@dreamorosi dreamorosi removed the pending-release This item has been merged and will be released soon label Oct 27, 2022
@dreamorosi dreamorosi added the logger This item relates to the Logger Utility label Nov 13, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
@dreamorosi dreamorosi changed the title Documentation (logger): incorrect formatting of alert block Documentation: incorrect formatting of alert block 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 good-first-issue Something that is suitable for those who want to start contributing logger This item relates to the Logger Utility
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant