search

aws-powertools / powertools-lambda-java

Powertools is a developer toolkit to implement Serverless best practices and increase developer velocity.
https://docs.powertools.aws.dev/lambda/java/
MIT No Attribution
285 stars 87 forks source link

Docs: Improve Examples coverage #1067

Closed scottgerring closed 11 months ago

scottgerring commented 1 year ago

What were you searching in the docs?

The examples that will be packaged as part of #1051

Is this related to an existing documentation section?

No response

How can we improve?

At a coarse level, we are missing example coverage of powertools-cloudformation and the coverage of the tracing, logging, and metrics library doesn't line up with the module structure.

At a fine-grained level we should check feature coverage within each example and expand as necessary.

Got a suggestion in mind?

No response

Acknowledgment

jeromevdl commented 1 year ago

Adding that we should have examples using other frameworks than SAM (from the discussion here: https://github.com/awslabs/aws-lambda-powertools-java/issues/1074): SST, serverless fwk, terraform...

mriccia commented 1 year ago

I started working on this in the cf-customresource-examples branch

scottgerring commented 1 year ago

We are missing also an example for powertools-large-messages !

scottgerring commented 1 year ago

Example for powertools-large-messages moved into ticket #1353 to be worked on separately.

@AlexeySoshin working in #1067 - this current ticket - on CDK and Serverless Framework examples @AlexeySoshin , can you write back on this ticket so I can assign it to you ?

AlexeySoshin commented 1 year ago

Sure, happy to take #1353 part!

scottgerring commented 1 year ago

I will add an example for Gradle in #1359

jeromevdl commented 11 months ago

@skal111 will take that one: #1445 (terraform)

scottgerring commented 11 months ago

At this point we have such extensive example coverage we can close this.