docs(homepage): Change installation to CDK v2

[keithrozario]

Issue number: #4353

Summary

Updated the docs/homepage to reflect CDK v2 instead of CDK v1.

Changes

Changed the docs/homepage. Installation steps are now for CDK v2 instead CDK v1. The original docs had a CDK v1 implementation which would fail if the user used CDK v2 with an ImportError. Also tidied up the environment to use Aws.Region. This drops in Ref: AWS::Region in the cloudformation stack and should work across all regions.

User experience

No user experience changes.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

No. **RFC issue number**:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

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.

[boring-cyborg]

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #python channel on our Powertools for AWS Lambda Discord: Invite link

[heitorlessa]

Hey Keith thanks a lot for this quality improvement 👌 -- could you also open up a docs issue as we require for PRs?

[keithrozario]

Thanks @heitorlessa. Done.

#4353

[leandrodamascena]

Hello @keithrozario, thank you for bringing this to our attention.
We have linter, type checking and others to try to keep our documentation as real as possible, the reason we don't get this error is because the code is inline in the md file. I'm thinking about moving this file to the examples folder and including it in md, so that our CI can observe it. Could you do this please? If you don't have time now, I can do and approve/merge this PR today.

[keithrozario]

Thanks @leandrodamascena I can certainly do that -- but perhaps not today :).

But I'm also thinking there's a trade-off.

For example, this snippet doesn't include the code, or handler props because it focuses on the most important piece, the layers prop of the function. Including details to make this 'workable' might distract from what we're actually trying to communicate in the docs.

Thoughts?

[leandrodamascena]

For example, this snippet doesn't include the code, or handler props because it focuses on the most important piece, the layers prop of the function. Including details to make this 'workable' might distract from what we're actually trying to communicate in the docs.

Yes, really good points to worry about. But I think we have a solution:

1 – We can highlight lines to show what is most important in that example
2 - We can add a tip button to help the customer understand what that line means

Wjhat do you think about?

[keithrozario]

Makes sense. I'll work on that soon :)

[keithrozario]

I was performing the change today, I thought it would be best to move all code snippets to the examples folder. I thought this would make it more consistent, and we would be able to lint/check these files more accurately in the future.

I also noticed the SAR example was using CDK v1, and upgraded that to CDK v2 as well.

It does introduce a bunch of new example files -- but the index.md now looks a lots more cleaner and consistent just referencing those code blocks rather than including them in-line (in my view at least :))

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
2 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[leandrodamascena]

Hey @keithrozario! Fantastic changes, and we're now able to identify inconsistencies more effectively since we're running linter/formatter on those files. I made some minor adjustments, and it's now ready for merging 🚀

[boring-cyborg]

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!