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.

Sign up for GitHub

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

Jump to bottom

Improve documentation around variable behaviour and gotchas #3636

Merged
merged 1 commit into from Dec 17, 2020
Merged

Improve documentation around variable behaviour and gotchas #3636

merged 1 commit into from Dec 17, 2020

Commits on Dec 16, 2020

  1. Improve documentation around variable behaviour and gotchas 

    We used to link from the docs directory's README.md to our variables.md doc
but variables.md doesn't really explain the way variables work - it just
describes what values they can be used for and where they can be used in
our CRDs.

This commit changes the docs directory's README.md to point at the variable
documentation in our task doc, and adds a few lines there to talk a bit
more about how the substitution happens.

This commit also describes how to safely inject variables into `bash`
`script` blocks in Tasks without accidentally eval'ing the variable
contents.
    Scott committed Dec 16, 2020
    Configuration menu
    Copy the full SHA
    8d7b300 View commit details
    Browse the repository at this point in the history