Merge branch 'master' into circleci-test

This commit is contained in:
Megan Marsh 2018-11-16 14:18:28 -08:00 committed by GitHub
commit 62c8ee56b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions

View File

@ -24,10 +24,13 @@ configuration templates work yet, please read that page first.
## Usage
User variables must first be defined in a `variables` section within your
template. Even if you want a user variable to default to an empty string, it
must be defined. This explicitness helps reduce the time it takes for newcomers
to understand what can be modified using variables in your template.
In order to set a user variable, you must define it either within the
`variables` section within your template, or using the command-line `-var` or
`-var-file` flags.
Even if you want a user variable to default to an empty string, it is best to
explicitly define it. This explicitness helps reduce the time it takes for
newcomers to understand what can be modified using variables in your template.
The `variables` section is a key/value mapping of the user variable name to a
default value. A default value can be the empty string. An example is shown