Skip to content

docs(maintenance): update Middy sections #1524

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 3 commits into from
Jun 21, 2023
Merged

docs(maintenance): update Middy sections #1524

merged 3 commits into from
Jun 21, 2023

Conversation

dreamorosi
Copy link
Contributor

Description of your changes

Following internal feedback, this PR addresses the concerns described in the linked issue as well as two other docs-related issues.

Middy

The callouts related to Middy in the docs have been updated to clarify that Powertools supports only Middy v3.x (current latest being v4.x). In doing so I updated also the command to install the correct version as well as linking to the new section of the Middy docs dedicated to Powertools.

Tracer

The code snippets related to patching/capturing AWS SDK clients have been updated to show a more realistic example of usage. Prior to this change the examples were only showing the capture action but were not explaining how to use the patched client.

Now the snippets use a variable to store the patched client and show how to export the patched client in a way that allows usage in other modules.

General

The PR also reintroduces the MKDocs feature that allows to copy/paste code snippets which was mistakenly removed.

Related issues, RFCs

Issue number: #1523

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my change is effective and works
  • The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

  • I have documented the migration process
  • I have added, implemented necessary 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.

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

@dreamorosi dreamorosi requested a review from a team June 20, 2023 15:42
@dreamorosi dreamorosi self-assigned this Jun 20, 2023
@dreamorosi dreamorosi merged commit 5cb0160 into main Jun 21, 2023
@dreamorosi dreamorosi deleted the chore/docs branch June 21, 2023 14:06
@dreamorosi dreamorosi linked an issue Jun 21, 2023 that may be closed by this pull request
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: clarify Middy version & usage
1 participant