docs: Breaking up Readme File into separate files to make it easier to read #607
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jschwarzwalder
force-pushed
the
reorder
branch
4 times, most recently
from
f0d6bc1 to
85d9263
Compare
jschwarzwalder
changed the title
jschwarzwalder
force-pushed
the
reorder
branch
15 times, most recently
from
71ddc18 to
31362f2
Compare
jschwarzwalder
force-pushed
the
reorder
branch
3 times, most recently
from
894c3d5 to
e0799b1
Compare
dhruvsood
reviewed
Aug 8, 2018
README.rst
Outdated
| Lambda Runtime. | ||
|
|
||
| - `SAM CLI (Beta) <#sam-cli-beta>`__ | ||
| - `Main features <#main-features>`__ |
There was a problem hiding this comment.
@jschwarzwalder, to reduce the need to navigate to each of these docs to learn what they are about, can you please add a couple of lines describing the content of each of these files?
There was a problem hiding this comment.
I simply removed the sections from this Readme and put them in separate files.
Previously there was simply a list of headings.
Do you want information for each of these headings? Better names for the pages?
Should I remove the links from these three and instead link to the Getting Started Section where I can add more descriptive titles?
…s applications locally.
|
@sooddhruv I've made updates. Let me know if you require future revisions. |
dhruvsood
approved these changes
Aug 8, 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes:
Content is still included, but I added three files to pull out installation instructions, basic usage, and advanced usage.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.