chore(examples): updated contributing & docs with SAM

[dreamorosi]

Description of your changes

Now that the project offers SAM-based examples, there are some changes needed to the documentation, contributing guidelines, and readme files needed to reflect this change. This PR introduces these changes and it should be the last one related to SAM.

List of changes:

Readme files

This includes:

• Project's README.md
• packages/tracer/README.md
• packages/metrics/README.md
• packages/logger/README.md

The "Examples" link above used to bring you to the examples/cdk folder, it now brings you to examples so you can choose your favourite flavour to use.

Added the link to the SAM samples under the "Examples" section.

Documentation

In the main page (docs/index.md) there is a list of items under the "Examples" section, I have added an item for SAM

Contributing

I have added AWS SAM CLI as requirement for the project, as it's now needed in order to build the SAM sample as part of the pre-push hook. (This is similar to CDK, but since SAM CLI is not vended via NPM we must install it manually).

Finally I also added the Open in GitPod button that will automatically create the setup to start contributing in a few seconds.

Gitpod / Codespaces

With the latest changes I have made changes also to the configurations needed to use GitHub Codespaces & Gitpod. These include the addition of SAM CLI, as well as the initialisation of both example folders. This last step is needed to successfully execute the pre-push hooks.

How to verify this change

Check content of the CONTRIBUTING readme (link to rendered version in this PR), and optionally check README files + docs links to examples.

If you want to try the Gitpod setup click here (it will open a new Gitpod workspace in your account using this branch).

Related issues, RFCs

#849
#674

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have made corresponding changes to the documentation
• I have made corresponding changes to the examples
• My changes generate no new warnings
• The code coverage hasn't decreased
• New and existing unit tests pass locally and in Github Actions
• The PR title follows the conventional commit semantics

Breaking change checklist

N/A

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[flochaz]

Great !!!

[ijemmy]

Wondering if we might want to wait until #877 is merged (Node16) and just do this in one go?

[dreamorosi]

Wondering if we might want to wait until #877 is merged (Node16) and just do this in one go?

Thought about that, but at the same time I wanted to follow the CONTRIBUTING guidelines and keep the PR focused & w/ small diff (both are already quite big).