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

Feature request: Have a documentaton for each SAM template #425

Open
adrienarcuri opened this issue Jun 6, 2023 · 3 comments
Open

Feature request: Have a documentaton for each SAM template #425

adrienarcuri opened this issue Jun 6, 2023 · 3 comments

Comments

@adrienarcuri
Copy link

Describe your idea/feature/enhancement

I which AWS SAM CLI Application Templates would have an explanation of every template that is presented when using the AWS SAM CLI command 'sam init'.

The template are the following:
1 - Hello World Example
2 - Data processing
3 - Hello World Example With Powertools
...
14 - Machine Learning

Proposal

For each template, it have:

  • a brief description
  • a list of deployed components in AWS
  • a diagram of deployed component in AWS

Additional Details

@adrienarcuri adrienarcuri added stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. type/feature labels Jun 6, 2023
@adrienarcuri adrienarcuri changed the title Feature request: TITLE Feature request: Have a documentaton for each SAM template Jun 6, 2023
@mildaniel
Copy link
Contributor

Hey @adrienarcuri, I like this idea. I think some of the names here might be a little bit confusing and this could be a useful UX improvement. If you're open to contributing, we would be happy to review your PR!

@mildaniel mildaniel removed the stage/needs-triage Automatically applied to new issues and PRs, indicating they haven't been looked at. label Jun 7, 2023
@adrienarcuri
Copy link
Author

@mildaniel I'm open to contributing.
Know that I am new user of SAM service.
If I'm not mistaken, each SAM template corresponds to a CloudFormation template, is that correct?
Could you tell me where I can find the CloudFormation templates corresponding to each SAM template please? Thanks to this information I can understand which resources are deployed for each SAM template and provide a description and a diagram for each template. Thanks in advance.

@mildaniel
Copy link
Contributor

You're right that SAM templates correspond to CFN templates. SAM templates are actually supersets of CFN templates, so any CFN resource in the SAM template works as is. In terms of SAM resources, they get broken down into CFN resources, but I think it's sufficient to just use the SAM resource in the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants