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: surface new 1.12.0 features and enhancements #344

Merged
merged 8 commits into from
Mar 17, 2021

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Mar 17, 2021

Issue #, if available:

Description of changes:

Surface new functionalities, enhancements, and refresh docs to better surface certain features previously hidden:

  • Parameters: surface how to change cache TTL
  • Parameters: add new force_fetch param
  • Parameters: refresh to use new navigation
  • Idempotency: add note on reusing a single table for idempotency state
  • Logger: surface usage of new correlation_id and paths
  • Dataclasses: remove additional note banners to ease reading
  • Dataclasses: update AppSync Resolver to emphasize correlation, typos

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.

@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Mar 17, 2021
@michaelbrewer
Copy link
Contributor

@heitorlessa

I do have some code example use cases for force_fetch in the PR description:

And a code example of the AppSync decorator:

Co-authored-by: Michael Brewer <michael.brewer@gyft.com>
@codecov-io
Copy link

codecov-io commented Mar 17, 2021

Codecov Report

Merging #344 (393405e) into develop (b365fba) will increase coverage by 0.28%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #344      +/-   ##
===========================================
+ Coverage    99.60%   99.88%   +0.28%     
===========================================
  Files           95       95              
  Lines         3508     3529      +21     
  Branches       173      173              
===========================================
+ Hits          3494     3525      +31     
+ Misses           8        2       -6     
+ Partials         6        2       -4     
Impacted Files Coverage Δ
aws_lambda_powertools/logging/logger.py 100.00% <0.00%> (ø)
aws_lambda_powertools/tracing/tracer.py 100.00% <0.00%> (ø)
aws_lambda_powertools/metrics/metrics.py 100.00% <0.00%> (ø)
aws_lambda_powertools/logging/formatter.py 100.00% <0.00%> (ø)
aws_lambda_powertools/utilities/batch/base.py 100.00% <0.00%> (ø)
aws_lambda_powertools/shared/jmespath_functions.py 100.00% <0.00%> (ø)
...ws_lambda_powertools/middleware_factory/factory.py 100.00% <0.00%> (ø)
...s_lambda_powertools/utilities/parser/models/sns.py 100.00% <0.00%> (ø)
...mbda_powertools/utilities/parser/models/kinesis.py 100.00% <0.00%> (ø)
...a_powertools/utilities/parser/models/cloudwatch.py 100.00% <0.00%> (ø)
... and 1 more

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 b365fba...393405e. Read the comment docs.

Copy link
Contributor

@michaelbrewer michaelbrewer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks cool.

We might want to remove the New in 1.12.0 in future releases as we might start to clutter the docs. It could be some kind of expiring things :)

:shipit:

@heitorlessa
Copy link
Contributor Author

@heitorlessa

I do have some code example use cases for force_fetch in the PR description:

* #341

And a code example of the AppSync decorator:

* #323

Thanks Michael - I found the first example being better suited for a new Guide section, as we'd want to keep it brief.

The App Resolver decorator, there's a high chance (90%) this will be moved once the RFC #325 and #322 get more details, so let's keep this undocumented for now.

@heitorlessa
Copy link
Contributor Author

Looks cool.

We might want to remove the New in 1.12.0 in future releases as we might start to clutter the docs. It could be some kind of expiring things :)

:shipit:

Actually there's going to be an even better news that this will no longer be necessary - Our documentation system now supports versioning, meaning we could have that for either per release tag OR per branch (less convoluted)

https://squidfunk.github.io/mkdocs-material/changelog/#700-_-february-22-2021

@heitorlessa heitorlessa merged commit 4c55108 into aws-powertools:develop Mar 17, 2021
@heitorlessa heitorlessa deleted the docs/prepare-1.12.0 branch March 17, 2021 14:13
@michaelbrewer
Copy link
Contributor

@heitorlessa
I do have some code example use cases for force_fetch in the PR description:

* #341

And a code example of the AppSync decorator:

* #323

Thanks Michael - I found the first example being better suited for a new Guide section, as we'd want to keep it brief.

The App Resolver decorator, there's a high chance (90%) this will be moved once the RFC #325 and #322 get more details, so let's keep this undocumented for now.

Sounds good. Maybe we have a cookbook guide somewhere that has more detailed use cases (or it could just be blog posts we refer to)

@heitorlessa
Copy link
Contributor Author

@heitorlessa
I do have some code example use cases for force_fetch in the PR description:

* #341

And a code example of the AppSync decorator:

* #323

Thanks Michael - I found the first example being better suited for a new Guide section, as we'd want to keep it brief.
The App Resolver decorator, there's a high chance (90%) this will be moved once the RFC #325 and #322 get more details, so let's keep this undocumented for now.

Sounds good. Maybe we have a cookbook guide somewhere that has more detailed use cases (or it could just be blog posts we refer to)

Indeed - Cookbook might be quicker to get these things for now as a Guide needs a lot more thought into it. Feel free to open a new discussion and we can get people's ideas on what good recipes we could add in

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants