docs(homepage): revamp install UX & share how we build Lambda Layer #1978
Conversation
heitorlessa
requested review from
leandrodamascena
and removed request for
a team
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/M
|
hey @ericbn, I'd appreciate very much if you could have a look in the screenshots in the PR description to confirm whether that address your original ask. Once again, thank you for helping us improve and make the documentation clearer for everyone! Have a fantastic weekend. |
There was a problem hiding this comment.
Olá @heitorlessa. Thanks for the updated documentation and the detailed images with all the changes and callouts! Amazing work, I love it! You have a fantastic weekend too.
docs/index.md
Outdated
|
|
||
| Powertools relies on the [AWS SDK bundled in the Lambda runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-python.html){target="_blank"}. This helps us achieve an optimal package size and initialization. | ||
|
|
||
| However, when developing locally, you might want to have IDE autocompletion, or run your tests suite locally without any emulation like [AWS SAM CLI](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/install-sam-cli.html){target="_blank"}. For this to work, you need to install AWS SDK as a development dependency (not as a production dependency): |
There was a problem hiding this comment.
Can't we just simply say "However, when developing locally, you need to install AWS SDK as a development dependency (not as a production dependency)"?
I cannot think of any general scenario where developing locally without AWS SDK makes sense. Or maybe you were just enumerating scenarios where having the AWS SDK locally helps, which makes sense too.
There was a problem hiding this comment.
The latter :) We have a few customers that aren't professional developers, so we try to raise awareness of why doing X could be helpful for the uninitiated.
That said, I'm gonna try another less verbose way to do that
There was a problem hiding this comment.
Shorten the first part as you suggested, and added a long form under a banner that is folded by default to be less distracting. For anyone wanting to learn more, they can simply click to collapse to know the theory behind it.
|
Made one tiny update to improve reading based on Eric's feedback!
|
|
As @rubenfonseca is unavailable this week, and @leandrodamascena is off until end of March, I'm merging as both Eric (customer) and myself are happy with it. |
…dge-dataclass * develop: chore(deps-dev): bump mkdocs-material from 9.1.1 to 9.1.2 (aws-powertools#1994) chore(deps-dev): bump mypy-boto3-dynamodb from 1.26.84 to 1.26.87 (aws-powertools#1993) chore(deps): bump pydantic from 1.10.5 to 1.10.6 (aws-powertools#1991) chore(deps-dev): bump aws-cdk-lib from 2.67.0 to 2.68.0 (aws-powertools#1992) chore(deps-dev): bump cfn-lint from 0.74.0 to 0.74.1 (aws-powertools#1988) chore(deps): bump aws-actions/configure-aws-credentials from 1 to 2 (aws-powertools#1987) update changelog with latest changes chore(deps-dev): bump pytest from 7.2.1 to 7.2.2 (aws-powertools#1980) fix(ci): bump CDK version chore(deps): bump zgosalvez/github-actions-ensure-sha-pinned-actions from 2.1.1 to 2.1.2 (aws-powertools#1979) chore(deps-dev): bump types-python-dateutil from 2.8.19.9 to 2.8.19.10 (aws-powertools#1973) chore(deps-dev): bump hvac from 1.0.2 to 1.1.0 (aws-powertools#1983) chore(deps-dev): bump mkdocs-material from 9.1.0 to 9.1.1 (aws-powertools#1984) update changelog with latest changes docs(homepage): revamp install UX & share how we build Lambda Layer (aws-powertools#1978) chore(deps-dev): bump mypy-boto3-dynamodb from 1.26.24 to 1.26.84 (aws-powertools#1981) chore(deps-dev): bump mkdocs-material from 9.0.15 to 9.1.0 (aws-powertools#1976) chore(deps-dev): bump cfn-lint from 0.67.0 to 0.74.0 (aws-powertools#1974)
Issue number: #1942
Summary
Changes
This addresses @ericbn feedback on dependency resolution, how exactly we build the Lambda Layer, and make more visible how to inspect the contents of the Lambda Layer.
While I was at it, I've updated the new Powertools description, improved the UX on copying/pasting install commands, and made the
Installsection in the Local development slightly crispier too.Tasks
[all]dependency[aws-sdk]actually means for newcomers[aws-sdk]might end up with the latest AWS SDK version locally vs Lambda runtimeUser 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.