powertools-lambda-typescript icon indicating copy to clipboard operation
powertools-lambda-typescript copied to clipboard

Documentation (all): add CDK, Terraform, Serverless Framework, Terraform, Amplify examples

Open dreamorosi opened this issue 3 years ago • 2 comments

Description of the improvement

Summary of the proposal

Currently the docs include an example on how to deploy the utility only using SAM but we could provide examples also for other frameworks (CDK, Terraform, Serverless Framework, Terraform, Amplify) as no everyone uses SAM.

Proposed by @ijemmy

How, where did you look for information

Homepage & Utility-specific pages

Missing or unclear documentation

How to deploy a Lambda Fn that uses Powertools

Improvement

Similar to what done in this section of the Python's docs: https://awslabs.github.io/aws-lambda-powertools-python/latest/#lambda-layer

Related existing documentation

N/A

Related issues, RFCs

Note for implementor: please check discussion in #520 . The discussion there is related to this issue implementation.

Summary of change requested in #520

  1. Separate Lambda (application) code and infrastructure code from each other.
  2. Make the Lambda code reusable for other tools. We don't want to manage a duplicated Lambda function code per framework. We should have one set of Lambda code that is deployable with different tools.
  3. The goal of example is to have deployable example so users can experiment with it easily. While we may include best practices where possible, it doesn't supersede this original goal.
  4. Avoid keeping transpiled JS in Git repo at all cost.

As the code structure can be controversial, please put a proposal and ping one of the maintainers before creating PR to avoid rework.

dreamorosi avatar Jan 03 '22 16:01 dreamorosi

@dreamorosi - maybe at least the most common ones for Typescript today? I assume internally you have some stats on this

michaelbrewer avatar Jan 06 '22 12:01 michaelbrewer

Maybe for guidance on the deployment we should simply refer to our examples folder. Either way, not a must have for the GA milestone.

saragerion avatar May 16 '22 09:05 saragerion

Since we have launched Lambda Layers the documentation now has examples of how to use the layers with all the frameworks mentioned above.

I will close this umbrella issue, however I'm in favor of adding additional examples under the examples/* folder if there's customer demand. In that case we'll discuss it in dedicated issues.

dreamorosi avatar Oct 19 '22 10:10 dreamorosi

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see. If you need more assistance, please either tag a team member or open a new issue that references this one. If you wish to keep having a conversation with other community members under this issue feel free to do so.

github-actions[bot] avatar Oct 19 '22 10:10 github-actions[bot]