docs(maintenance): update Middy sections #1524
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Breaking change checklist
Is it a breaking change?: NO
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.