chore(examples): updated contributing & docs with SAM #876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…aws-lambda-powertools-typescript into chore/aamorosi/sam_docs
dreamorosi
added
documentation
ijemmy
previously approved these changes
May 23, 2022
|
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 |
Co-authored-by: ijemmy <[email protected]>
ijemmy
previously approved these changes
May 24, 2022
flochaz
reviewed
May 24, 2022
Co-authored-by: Florian Chazal <[email protected]>
flochaz
approved these changes
May 25, 2022
saragerion
approved these changes
May 25, 2022
flochaz
added a commit
that referenced
this pull request
Jun 3, 2022
* chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: add sam to gitpod * chore: updated gitpod.yml * chore: updated gitpod.yml * chore: updated gitpod.yml * Update CONTRIBUTING.md Co-authored-by: ijemmy <[email protected]> * Update .devcontainer/devcontainer.json Co-authored-by: Florian Chazal <[email protected]> Co-authored-by: ijemmy <[email protected]> Co-authored-by: Florian Chazal <[email protected]>
dreamorosi
added a commit
that referenced
this pull request
Aug 2, 2022
* chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: updated contributing & docs with SAM * chore: add sam to gitpod * chore: updated gitpod.yml * chore: updated gitpod.yml * chore: updated gitpod.yml * Update CONTRIBUTING.md Co-authored-by: ijemmy <[email protected]> * Update .devcontainer/devcontainer.json Co-authored-by: Florian Chazal <[email protected]> Co-authored-by: ijemmy <[email protected]> Co-authored-by: Florian Chazal <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
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:
packages/tracer/README.mdpackages/metrics/README.mdpackages/logger/README.mdThe "Examples" link above used to bring you to the
examples/cdkfolder, it now brings you toexamplesso 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 SAMContributing
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
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.