Skip to content
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 environment file example #157

Merged
merged 1 commit into from
Oct 11, 2017

Conversation

developius
Copy link
Contributor

Signed-off-by: Finnian Anderson get@finnian.io

In the README, there is an example for the environment_file which has the incorrect syntax for the yaml.

Description

This:

environment:
  - access_key: key1
  - secret_key: key2

Should be this:

environment:
  access_key: key1
  secret_key: key2

I've also added a couple of missing yaml code block syntax highlighting labels.

Motivation and Context

Misleading example, had to battle with it for 10 minutes so I thought it would be nice to update the example so others don't encounter the same issue.

  • I have raised an issue to propose this change (required)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Signed-off-by: Finnian Anderson <get@finnian.io>
@alexellis
Copy link
Member

Good find 👍

@alexellis alexellis merged commit faf7921 into openfaas:master Oct 11, 2017
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.

None yet

2 participants