Skip to content

docs(tutorial): add new tutorial covering core features #769

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
merged 45 commits into from
Jan 15, 2022
Merged
Show file tree
Hide file tree
Changes from 44 commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
7392794
Add quickstart section in Readme.md
Oct 18, 2021
73da181
Move quickstart section to the documentation
Oct 25, 2021
86c9f96
Rewrite Quickstart section to follow narrative approach
Nov 28, 2021
fb24c83
Merge branch 'develop' into docs/quick-start
mploski Dec 2, 2021
abb7919
Rephrase multiple sections of quickstart and fix style errors
Dec 17, 2021
cc96e96
Add PR suggestions
Dec 22, 2021
2e465bb
Merge branch 'docs/quick-start' of github.com:mploski/aws-lambda-powe…
Dec 22, 2021
72c954b
Add PR suggestions
Dec 22, 2021
a3f6831
Add PR suggestions
Jan 5, 2022
4a6d081
Update docs/quickstart.md
mploski Jan 11, 2022
ae5414b
Update docs/quickstart.md
mploski Jan 11, 2022
52c629f
Update docs/quickstart.md
mploski Jan 11, 2022
74ee6da
Update docs/quickstart.md
mploski Jan 11, 2022
9f4ee51
Update docs/quickstart.md
mploski Jan 11, 2022
f665b87
Merge branch 'develop' into docs/quick-start
Jan 11, 2022
d23e582
Add some fixes based on PR comments
Jan 11, 2022
0e7b2eb
Move project structure into different section
Jan 13, 2022
4858b28
Fixing templates indentation
Jan 13, 2022
917f8bb
Fix code formatting and use json output
Jan 14, 2022
639b9e1
Add actioniable suggestion to implement authorization for quickstart …
Jan 14, 2022
e1a8f2c
Add tip about using different API testing tools
Jan 14, 2022
9b60f22
Rephrase intro in API Gateway router section
Jan 14, 2022
7371c68
Additional text tweaks
Jan 14, 2022
f24e265
docs(quickstart): tidy requirements up
heitorlessa Jan 14, 2022
bb71ce5
docs(quickstart): expand on intro line
heitorlessa Jan 14, 2022
0951f8d
docs(quickstart): sentence fragmentation, tidy up
heitorlessa Jan 14, 2022
6584364
docs(quickstart): add sub-sections, fix highlight & code
heitorlessa Jan 14, 2022
9cca95c
docs(quickstart): same process for Logger
heitorlessa Jan 14, 2022
9343fa9
docs(quickstart): make section agnostic to json lib
heitorlessa Jan 15, 2022
f03b0fc
fix: remove f-strings that doesn't evaluate expr
heitorlessa Jan 15, 2022
4b94856
fix: incorrect log keys, indentation, snippet consistency
heitorlessa Jan 15, 2022
3af2cac
revert: order to APP logger/service name due to screenshots
heitorlessa Jan 15, 2022
b096f5f
docs(tracer): warning to note on local traces
heitorlessa Jan 15, 2022
9e9b2cd
fix: use decorators, split cold start to ease reading
heitorlessa Jan 15, 2022
931de51
fix: remove apigw contract when using event-handler, apigw tracing
heitorlessa Jan 15, 2022
1b307d2
docs(tracer): add initial image, requirements
heitorlessa Jan 15, 2022
12b35f5
docs(tracer): add annotation, metadata, and image
heitorlessa Jan 15, 2022
f35321f
docs(tracer): update ServiceLens image w/ API GW, copywriting
heitorlessa Jan 15, 2022
d2cb261
fix: remove unused json import
heitorlessa Jan 15, 2022
411ee85
docs(metrics): keep it consistent with other sections, update metric …
heitorlessa Jan 15, 2022
f6e2b92
docs: add final consideration section
heitorlessa Jan 15, 2022
5618a99
docs: rename to tutorial given the size
heitorlessa Jan 15, 2022
4fd97ea
Merge branch 'develop' into docs/quick-start
heitorlessa Jan 15, 2022
d2925a3
docs: rename quickstart to tutorial in readme
heitorlessa Jan 15, 2022
e5e23d1
Add small style improvements and corrections
Jan 15, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

A suite of Python utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Java](https://github.com/awslabs/aws-lambda-powertools-java) and [Typescript](https://github.com/awslabs/aws-lambda-powertools-typescript) is also available).

**[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Quick hello world example](https://github.com/aws-samples/cookiecutter-aws-sam-python)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**
**[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**

> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**

Expand All @@ -27,12 +27,15 @@ A suite of Python utilities for AWS Lambda functions to ease adopting best pract
* **[Idempotency](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/idempotency/)** - Convert your Lambda functions into idempotent operations which are safe to retry
* **[Feature Flags](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/feature_flags/)** - A simple rule engine to evaluate when one or multiple features should be enabled depending on the input


### Installation

With [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip install aws-lambda-powertools``

## Examples

## Tutorial and Examples

* [Tutorial](https://awslabs.github.io/aws-lambda-powertools-python/latest/tutorial)
* [Serverless Shopping cart](https://github.com/aws-samples/aws-serverless-shopping-cart)
* [Serverless Airline](https://github.com/aws-samples/aws-serverless-airline-booking)
* [Serverless E-commerce platform](https://github.com/aws-samples/aws-serverless-ecommerce-platform)
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/metrics_utility_showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/tracer_utility_showcase_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/tracer_utility_showcase_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/tracer_xray_sdk_enriched.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/tracer_xray_sdk_enriched_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/media/tracer_xray_sdk_showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,037 changes: 1,037 additions & 0 deletions docs/tutorial.md

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ edit_uri: edit/develop/docs
nav:
- Homepage: index.md
- Changelog: changelog.md
- Tutorial: tutorial.md
- Roadmap: https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1" target="_blank
- API reference: api/" target="_blank
- Core utilities:
- core/tracer.md
- core/logger.md
- core/metrics.md
- Event Handler:
- core/event_handler/appsync.md
- core/event_handler/api_gateway.md
- core/event_handler/appsync.md
- core/event_handler/api_gateway.md
- Utilities:
- utilities/middleware_factory.md
- utilities/parameters.md
Expand Down Expand Up @@ -64,7 +65,7 @@ markdown_extensions:
- pymdownx.superfences
- pymdownx.details
- pymdownx.snippets:
base_path: '.'
base_path: "."
check_paths: true
- meta
- toc:
Expand Down