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(tutorial): fix broken internal links #1000

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Feb 4, 2022

Issue #, if available:

Description of changes:

All links pointing to other internal sections (e.g. Tracer, Logger) and their respective sections were broken.

We also update Event Handler example (ApiGatewayResolver) to use the new specialized one APIGatewayRestResolver to give customers a first class experience on autocompleting available properties.

Checklist

Breaking change checklist

RFC issue #:

  • Migration process documented
  • Implement warnings (if it can live side by side)

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.


View rendered docs/tutorial/index.md

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Feb 4, 2022
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 4, 2022
@codecov-commenter
Copy link

codecov-commenter commented Feb 4, 2022

Codecov Report

Merging #1000 (ea611a1) into develop (168ec48) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #1000   +/-   ##
========================================
  Coverage    99.96%   99.96%           
========================================
  Files          119      119           
  Lines         5347     5347           
  Branches       610      610           
========================================
  Hits          5345     5345           
  Partials         2        2           
Impacted Files Coverage Δ
aws_lambda_powertools/event_handler/__init__.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 168ec48...ea611a1. Read the comment docs.

@heitorlessa
Copy link
Contributor Author

Also discovered we accidentally slipped the top level imports for event handler while running through the tutorial.

Initially added here: #978

Adding the fix as part of this PR too.

@pull-request-size pull-request-size bot removed the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Feb 4, 2022
@pull-request-size pull-request-size bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Feb 4, 2022
@heitorlessa heitorlessa merged commit 1eb9bb3 into aws-powertools:develop Feb 4, 2022
@heitorlessa heitorlessa deleted the docs/tutorial-broken-links branch February 4, 2022 13:46
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 size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants