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(home): extract and fix examples #1113

Closed
wants to merge 22 commits into from

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Apr 12, 2022

Issue number:

Summary

Extract code examples from landing page and fix errors in python, yaml

Changes

Changes:

  • Extract all code examples
  • Fix yaml, terraform and python
  • Update line highlights to be correct
  • Use latest version of powertools in the examples
  • Add make file to format, lint, compile and validate examples to prevent errors from coming back
  • Update SAR version to 1.26.1
  • Update layer version to 1.26.1

Bug fixes in this PR:

Terraform fix Changes:

  • Fix the line number highlight for the lambda layer
  • aws provider needs to be a newer version to support python3.9 runtime
  • Use jsonencode instead of <<EOF to fix the formatting of the terraform snippet
  • run terraform fmt

Confirmed terraform changes by:

  • terraform init
  • tflint
  • terraform plan

User experience

Please share what the user experience looks like before and after this change

Hosted version is here: https://gyft.github.io/aws-lambda-powertools-python/latest/

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

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

Acknowledgment

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.


View rendered docs/index.md

Changes:
- Extract all code examples
- Fix yaml, terraform and python
- Add make file to format, lint and validate examples

Related to
- aws-powertools#1064

Fixed
- aws-powertools#1067
- aws-powertools#1069
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 12, 2022
@boring-cyborg boring-cyborg bot added documentation Improvements or additions to documentation internal Maintenance changes labels Apr 12, 2022
@github-actions github-actions bot added the bug Something isn't working label Apr 12, 2022
@codecov-commenter
Copy link

codecov-commenter commented Apr 12, 2022

Codecov Report

Merging #1113 (41124d1) into develop (f62d07a) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #1113   +/-   ##
========================================
  Coverage    99.88%   99.88%           
========================================
  Files          119      119           
  Lines         5423     5423           
  Branches       618      618           
========================================
  Hits          5417     5417           
  Misses           2        2           
  Partials         4        4           

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 f62d07a...41124d1. Read the comment docs.

@michaelbrewer
Copy link
Contributor Author

@heitorlessa as per your request, i am breaking the larger PR #1065 into 16 smaller PRs. This one is the for index.md landing page examples.

@michaelbrewer michaelbrewer changed the title fix: Extract landing page docs fix(docs): Extract landing page docs Apr 13, 2022
@michaelbrewer michaelbrewer changed the title fix(docs): Extract landing page docs fix(docs): Extract HomePage code examples Apr 13, 2022
@michaelbrewer michaelbrewer changed the title fix(docs): Extract HomePage code examples fix(docs): Extract and fix HomePage code examples Apr 20, 2022
@heitorlessa heitorlessa changed the title fix(docs): Extract and fix HomePage code examples docs(home): extract and fix HomePage code examples Apr 26, 2022
@heitorlessa heitorlessa removed the bug Something isn't working label Apr 26, 2022
@heitorlessa heitorlessa changed the title docs(home): extract and fix HomePage code examples docs(home): extract and fix examples Apr 26, 2022
@sthulb sthulb closed this Jun 14, 2022
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 internal Maintenance changes size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
4 participants