Skip to content
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

Docs: Improve Examples coverage #1067

Closed
1 task done
scottgerring opened this issue Feb 21, 2023 · 8 comments
Closed
1 task done

Docs: Improve Examples coverage #1067

scottgerring opened this issue Feb 21, 2023 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority:3 Neutral - not a core feature or affects less than 40% of users

Comments

@scottgerring
Copy link
Contributor

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

  • I understand the final update might be different from my proposed suggestion, or refused.
@scottgerring scottgerring added documentation Improvements or additions to documentation triage labels Feb 21, 2023
@scottgerring scottgerring self-assigned this Feb 21, 2023
@machafer machafer moved this to Working on it in AWS Lambda Powertools for Java Feb 24, 2023
@scottgerring scottgerring moved this from Working on it to On hold in AWS Lambda Powertools for Java Feb 24, 2023
@jeromevdl
Copy link
Contributor

jeromevdl commented Feb 24, 2023

Adding that we should have examples using other frameworks than SAM (from the discussion here: #1074): SST, serverless fwk, terraform...

@scottgerring scottgerring added the good first issue Good for newcomers label Mar 2, 2023
@scottgerring scottgerring assigned mriccia and unassigned scottgerring Mar 2, 2023
@mriccia
Copy link
Contributor

mriccia commented Mar 2, 2023

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

@jeromevdl jeromevdl added the priority:3 Neutral - not a core feature or affects less than 40% of users label Jul 17, 2023
@jeromevdl jeromevdl moved this from On hold to Working on it in Powertools for AWS Lambda (Java) Jul 17, 2023
@jeromevdl jeromevdl removed the triage label Jul 17, 2023
@scottgerring
Copy link
Contributor Author

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

@scottgerring
Copy link
Contributor Author

scottgerring commented Aug 8, 2023

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
Copy link
Contributor

Sure, happy to take #1353 part!

@scottgerring
Copy link
Contributor Author

I will add an example for Gradle in #1359

@jeromevdl
Copy link
Contributor

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

@scottgerring
Copy link
Contributor Author

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

@jeromevdl jeromevdl moved this from Working on it to Shipped in Powertools for AWS Lambda (Java) Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority:3 Neutral - not a core feature or affects less than 40% of users
Projects
Status: Shipped
Development

When branches are created from issues, their pull requests are automatically linked.

4 participants