Skip to content

Documentation Suggestion: Update README with clarification on --env-vars usage#610

Merged
jfuss merged 3 commits intoaws:developfrom
bdunbar22:develop
Aug 17, 2018
Merged

Documentation Suggestion: Update README with clarification on --env-vars usage#610
jfuss merged 3 commits intoaws:developfrom
bdunbar22:develop

Conversation

@bdunbar22
Copy link

Issue #, if available:

Description of changes:

As discussed in #538, a suggestion to clarify the wording around the --env-vars option in the readme.

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

@bdunbar22
Copy link
Author

Hi @jfuss, here is a new PR for the --env-vars suggestion that we had discussed in #538. I hope it works for you.

@jfuss
Copy link
Contributor

jfuss commented Aug 10, 2018

@bdunbar22 We had some work done on splitting up our README. Would you be able to pull the new files and make your update here?

@jfuss jfuss added area/docs stage/in-progress A fix is being worked on labels Aug 10, 2018
Copy link
Contributor

@jfuss jfuss left a comment

Choose a reason for hiding this comment

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

Thanks for the update!

@jfuss jfuss added stage/accepted Accepted and will be fixed and removed stage/in-progress A fix is being worked on labels Aug 16, 2018
@bdunbar22
Copy link
Author

Hi @jfuss, you're welcome!

@jfuss jfuss merged commit b908957 into aws:develop Aug 17, 2018
jfuss added a commit that referenced this pull request Aug 28, 2018
* fix: Functional tests must run on localhost to work in Windows (#552)

* fix: spacing typo in Log statement in start-lambda (#559)

* docs: Fix syntax highlighting in README.md (#561)

* docs: Change jest to mocha in Nodejs init README (#564)

* docs: Fix @mhart link in README (#562)

* docs(README): removed cloudtrail, added SNS to generate-event (#569)

* docs: Update repo name references (#577)

* feat(debugging): Fixing issues around debugging Golang functions. (#565)

* fix(init): Improve current init samples around docs and fixes (#558)

* docs(README): Update launch config to SAM CLI from SAM Local (#587)

* docs(README): Update sample code for calling Local Lambda Invoke (#584)

* refactor(init): renamed handler for camel case, moved callback call up (#586)

* chore: aws-lambda-java-core 1.1.0 -> 1.2.0 for java sam init (#578)

* feat(validate): Add profile and region options (#582)

Currently, `sam validate` requires AWS Creds (due to the SAM Translator).
This commits adds the ability to pass in the credientials through a profile
that is configured through `aws configure`.

* docs(README): Update README prerequisites to include awscli (#596)

* fix(start-lambda): Remove Content-Type Header check (#594)

* docs: Disambiguation "Amazon Kinesis" (#599)

* docs: Adding instructions for how to add pyenv to your PATH for Windows (#600)

* docs: Update README with small grammar fix (#601)

* fix: Update link in NodeJS package.json (#603)

* docs: Creating instructions for Windows users to install sam (#605)

* docs: Adding a note directing Windows users to use pipenv (#606)

* fix: Fix stringifying λ environment variables when using Python2 (#579)

* feat(generate-event): Added support for 50+ events (#612)

* feat(invoke): Add region parameter to all invoke related commands (#608)

* docs: Breaking up README into separate files to make it easier to read (#607)

* chore: Update JVM size params to match docker-lambda (#615)

* feat(invoke): Invoke Function Without Parameters through --no-event (#604)

* docs: Update advanced_usage.rst with clarification on --env-vars usage (#610)

* docs: Remove an extra word in the sam packaging command (#618)

* UX: Improves event names to reflect Lambda Event Sources (#619)

* docs: Fix git clone typo in installation docs (#630)

* docs(README): Callout go1.x runtime support (#631)

* docs(installation): Update sam --version command (#634)

* chore(0.6.0): SAM CLI Version bump (#635)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs stage/accepted Accepted and will be fixed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants