Skip to content

Docs: add CDK, Terraform, Serverless Framework, Terraform, Amplify examples #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dreamorosi opened this issue Jan 3, 2022 · 4 comments
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@dreamorosi
Copy link
Contributor

dreamorosi commented Jan 3, 2022

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 dreamorosi added the documentation Improvements or additions to documentation label Jan 3, 2022
@dreamorosi dreamorosi added this to the production-ready-release milestone Jan 3, 2022
@michaelbrewer
Copy link
Contributor

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

@saragerion saragerion added all triage This item has not been triaged by a maintainer, please wait labels Jan 6, 2022
@dreamorosi dreamorosi changed the title docs(all): add CDK, Terraform, Serverless Framework, Terraform, Amplify examples Documentation (all): add CDK, Terraform, Serverless Framework, Terraform, Amplify examples May 12, 2022
@saragerion
Copy link
Contributor

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 saragerion removed this from the production-ready-release milestone May 16, 2022
@dreamorosi
Copy link
Contributor Author

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.

@github-actions
Copy link
Contributor

⚠️ 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.

@dreamorosi dreamorosi removed the triage This item has not been triaged by a maintainer, please wait label Oct 19, 2022
@dreamorosi dreamorosi added the completed This item is complete and has been merged/shipped label Nov 14, 2022
@dreamorosi dreamorosi changed the title Documentation (all): add CDK, Terraform, Serverless Framework, Terraform, Amplify examples Docs: add CDK, Terraform, Serverless Framework, Terraform, Amplify examples Nov 14, 2022
@dreamorosi dreamorosi added internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) and removed internal PRs that introduce changes in governance, tech debt and chores (linting setup, baseline, etc.) labels Nov 14, 2022
@dreamorosi dreamorosi self-assigned this Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants