Skip to content

docs: Refresh Init READMEs#1308

Merged
jfuss merged 5 commits intoaws:developfrom
jfuss:update-init-readmes
Aug 9, 2019
Merged

docs: Refresh Init READMEs#1308
jfuss merged 5 commits intoaws:developfrom
jfuss:update-init-readmes

Conversation

@jfuss
Copy link
Contributor

@jfuss jfuss commented Aug 1, 2019

Issue #, if available:
N/A

Description of changes:
Refresh the READMEs. I wanted to get feedback on the NodeJS one before going further with others.

Main changes:

  • Format/restructure
  • Added notes about using the AWS Toolkit as another option for running/test/debugging within an IDE instead of the command line.
  • More detail in areas about using CFN and SAM in a single template, moving event.json into an events folder, more descriptive instructions for different command (build/package/deploy).

Checklist:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@jfuss jfuss requested review from sanathkr and sriram-mv and removed request for sriram-mv August 1, 2019 05:01
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is the prompt prefixed with "my-application"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe {{ cookiecutter.project_name }} might be better, but we dont know the full path on the client system.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But love the explicit instruction to create the S3 Bucket!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because I was going off of a more generic version of this and missed this when updating. Will update it with {{ cookiecutter.project_name }}

Copy link
Contributor

@sriram-mv sriram-mv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice refresh on the docs! 🔥

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe {{ cookiecutter.project_name }} might be better, but we dont know the full path on the client system.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But love the explicit instruction to create the S3 Bucket!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fetch logs generated by your "deployed" Lambda function? Does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. I think that addition makes sense.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does mentioning some specific SAR apps also make sense? helps the user to continue the journey to more complex apps.

@jfuss jfuss force-pushed the update-init-readmes branch from a019f2f to 3a5fc84 Compare August 7, 2019 04:46
@jfuss
Copy link
Contributor Author

jfuss commented Aug 7, 2019

Rebased with HEAD of develop, so appveyor should now pass.

@jfuss
Copy link
Contributor Author

jfuss commented Aug 7, 2019

I would like to get the Node Readme updated first. Once this one is completed, I will translate this into all the other init (except depreciated runtimes that we need to remove).

@jfuss jfuss merged commit 852ea84 into aws:develop Aug 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants