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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for use with serverless-offline #144

Merged
merged 1 commit into from Jul 4, 2017

Conversation

Projects
None yet
1 participant
@HyperBrain
Copy link
Member

HyperBrain commented Jul 4, 2017

What did you implement:

Obsoletes #104

Added detailed documentation about how to use the plugin together with serverless-offline and moved the docs into a new section as it was done with #104. Additionally mentioned the --location option and the two calling alternatives serverless offline and serverless offline start.

Moved the serve documentation near the end as we plan to remove it (see #135) and added a note about that discussion.

How did you implement it:

Modified the README.

How can we verify it:

Read the docs 馃槃

Todos:

  • [ ] Write tests
  • Write documentation
  • Fix linting errors (not yet implemented)
  • Make sure code coverage hasn't dropped (not yet implemented)
  • [ ] Provide verification config / commands / resources
  • [ ] Enable "Allow edits from maintainers" for this PR
  • Update the messages below

Is this ready for review?: YES
Is it a breaking change?: NO

@HyperBrain HyperBrain added this to the 2.0.0 milestone Jul 4, 2017

HyperBrain added a commit that referenced this pull request Jul 4, 2017

@HyperBrain HyperBrain merged commit 8741526 into master Jul 4, 2017

1 check passed

ci/circleci Your tests passed on CircleCI!
Details

@HyperBrain HyperBrain deleted the update-serverless-offline-docs branch Jul 4, 2017

HyperBrain added a commit that referenced this pull request Jul 4, 2017

Use MD links for issues and pull request references
Added #144

Added #132

Added #141

Added #140 and #131

Added release notes

HyperBrain added a commit that referenced this pull request Jul 4, 2017

Use MD links for issues and pull request references
Added #144

Added #132

Added #141

Added #140 and #131

Added release notes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment