saltstack/salt — Issue #757: Document idiosyncrasies of various renderers
Author: whiteinge
Created: 2012-02-25 07:58:11+00:00
State: open
Labels: Documentation

The individual renderer docs need to be fleshed out generally but specifically each one should include a section on idiosyncrasies and troubleshooting tips.

For example the YAML renderers should mention:

* Double-indentation fix for nested dictionaries
* Key-size limits (refs #651)
* Integers are not converted to strings
* Automatic hexadecimal conversion
* The syntax for multiline strings

The Jinja renderers should mention:

* Troubleshooting tips (via the Python repl)
* `.strip()` / `|trim()` -ing shell command output with a trailing newline
* `.split()` -ing multiline output so each line can be looped over