From 4e2936d2706993abf32687f23aa92a90c49b2d51 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Sat, 31 Aug 2013 17:38:38 -0700 Subject: [PATCH] website: document required user vars --- website/source/docs/templates/user-variables.html.markdown | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/source/docs/templates/user-variables.html.markdown b/website/source/docs/templates/user-variables.html.markdown index 99c59d11e..8f19aadea 100644 --- a/website/source/docs/templates/user-variables.html.markdown +++ b/website/source/docs/templates/user-variables.html.markdown @@ -48,6 +48,10 @@ In the above example, the template defines two variables: `aws_access_key` and Later, the variables are used within the builder we defined in order to configure the actual keys for the Amazon builder. +If the default value is `null`, then the user variable will be _required_. +This means that the user must specify a value for this variable or template +validation will fail. + Using the variables is extremely easy. Variables are used by calling the user function in the form of {{user `variable`}}. This function can be used in _any string_ within the template, in