Skip to content

docs(apigateway): re-add sample layout, add considerations #826

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

Merged

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Nov 16, 2021

Issue #, if available: #767

Description of changes:

This re-adds the sample layout back into the docs, optimizes for a single function, mypy, VSCode and PyCharm, etc.

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/core/event_handler/api_gateway.md

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Nov 16, 2021
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 16, 2021
@codecov-commenter
Copy link

codecov-commenter commented Nov 16, 2021

Codecov Report

Merging #826 (18e3c50) into develop (bda42a8) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #826   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files          118      118           
  Lines         5107     5107           
  Branches       279      279           
========================================
  Hits          5102     5102           
  Misses           2        2           
  Partials         3        3           

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 bda42a8...18e3c50. Read the comment docs.

@heitorlessa
Copy link
Contributor Author

cc @michaelbrewer - I need your review too to make sure the language is explicit enough, in case I missed anything.

Once this is merged I'll start drafting the release notes

@heitorlessa
Copy link
Contributor Author

@michaelbrewer
Copy link
Contributor

@heitorlessa - LGTM. Very few docs exist talking about layouts for larger projects 👌

@heitorlessa
Copy link
Contributor Author

Awesome, I'll start drafting the release notes tomorrow to give @cakepietoast a moment to read just in case he can catch anything out of the ordinary.

@heitorlessa heitorlessa merged commit c92c1c0 into aws-powertools:develop Nov 17, 2021
@heitorlessa heitorlessa deleted the docs/router-considerations branch November 17, 2021 09:53
heitorlessa added a commit that referenced this pull request Nov 17, 2021
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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants