docs(v2): document optional dependencies and local dev #1574
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
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/S
pull-request-size
bot
added
size/L
Co-authored-by: Heitor Lessa <lessa@amazon.com>
pull-request-size
bot
removed
the
size/L
boring-cyborg
bot
added
dependencies
pull-request-size
bot
added
the
size/XL
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
pull-request-size
bot
added
size/L
6 tasks
Codecov ReportBase: 99.42% // Head: 99.42% // No change to project coverage 👍
Additional details and impacted files@@ Coverage Diff @@
## v2 #1574 +/- ##
=======================================
Coverage 99.42% 99.42%
=======================================
Files 125 125
Lines 5726 5726
Branches 357 357
=======================================
Hits 5693 5693
Misses 18 18
Partials 15 15 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
rubenfonseca
approved these changes
Oct 7, 2022
rubenfonseca
pushed a commit
that referenced
this pull request
Oct 14, 2022
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.
Issue number: #1573
Summary
Changes
Documents optional dependencies customers will have to install for certain utilities (Tracer, Parser, Validation). It also adds a new section under
Installto cover AWS SDK being a dev dependency, and when it's not necessary (SAM CLI invoke).User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
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.
View rendered README.md
View rendered docs/index.md