chore(v2): document use of aws-crt-client (#1092)

[jreijn]

Issue #, if available: #1092

Description of changes:

• Added documentation for using the aws-crt-client with powertools (v2).
• Fixed some documentation issues with typos and code blocks.

Checklist

• Meet tenets criteria
• Update tests
• Update docs
• PR title follows conventional commit semantics

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.

[jeromevdl]

something missing here...

[jreijn]

I've tried to clarify it a bit more. I noticed I focussed too much on the parameters module, but other modules also use the url-connection client. Turned it into an example for a module and described that it depends on the PT module in use how to further configure the http client.

[jreijn]

@jeromevdl thank you for the thorough review! I've incorporated most of your suggestions and tried to be more explicit on the unclear part.

[scottgerring]

Nice! Couple of nitpicks inline but looking good. Also immediately helpful for the next time I need to remember how to set this all up :D

[jreijn]

Some great additions @scottgerring ! Thanks so much. I do have one outstanding issue for myself. I mentioned the <version>1.18.0</version> as the version for the dependency. As this is going into the v2 branch should I replace that with 2.x.x? As the code example is for the v2 branch.

[scottgerring]

Some great additions @scottgerring ! Thanks so much. I do have one outstanding issue for myself. I mentioned the <version>1.18.0</version> as the version for the dependency. As this is going into the v2 branch should I replace that with 2.x.x? As the code example is for the v2 branch.

If you use 2.0.0 we should be safe! We've got a rather rough script in the build that goes through and subs this all out when we do releases. I believe we're using 2.0.0 elsewhere in the docs.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[scottgerring]

LGTM! Cheers @jreijn