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

Fix broken Azure Hello World Example documentation #4888

Merged
merged 1 commit into from Jan 23, 2019

Conversation

Projects
5 participants
@eeg3
Copy link
Contributor

eeg3 commented Apr 7, 2018

The Azure Hello World example has several errors, including incorrect Provider Plugin name and incorrect invocation command.

What did you implement:

  1. Change plugin name in example documentation from 'serverless-azure' to the correct 'serverless-azure-functions' name. The 'serverless-azure' listed currently is the incorrect name of the package and does not exist.
  2. Changed the invocation command to a working command based on the Azure/boilerplate-azurefunctions parent project.
  3. Changed the expected test invocation output to match the sample event provided.

How did you implement it:

  1. Changed package name in document.
  2. Changed the invocation command in document.
  3. Changed example output in document.
  4. Ran all commands and verified successful example.

How can we verify it:

  1. Try the current command 'npm install -g serverless-azure' and it will receive a 404. Try the new command 'npm install -g serverless-azure-functions' and it will succeed.
  2. Try to the sls invocation based on on the original command it will fail with 'Function "helloWorld" doesn't exist in this Service'. Try the new command and it will run successfully with "Hello pragna" response.

Todos:

  • Write tests
  • Write documentation
  • Fix linting errors
  • Make sure code coverage hasn't dropped
  • 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

Fix broken Azure example
The example has several errors, including incorrect Provider Plugin name and incorrect invocation command.
@HyperBrain

This comment has been minimized.

Copy link
Member

HyperBrain commented May 10, 2018

@eeg3 Thanks for the improvements.

@serverless/vip Can anyone who actually uses Azure review the doc changes and see if they are ok? I will follow that review then and merge it afterwards.

@pmuens

pmuens approved these changes Jan 23, 2019

Copy link
Member

pmuens left a comment

LGTM. Thanks for fixing this @eeg3 👍

@pmuens pmuens self-assigned this Jan 23, 2019

@pmuens pmuens added this to In progress in Serverless via automation Jan 23, 2019

@pmuens pmuens merged commit b3f0058 into serverless:master Jan 23, 2019

3 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage increased (+0.02%) to 88.935%
Details

Serverless automation moved this from In progress to Done Jan 23, 2019

@pmuens pmuens added this to the 1.36.4 milestone Feb 5, 2019

@shortjared shortjared added the bug label Feb 6, 2019

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