diff options
author | Thomas Wiest <twiest@redhat.com> | 2015-06-24 10:39:26 -0400 |
---|---|---|
committer | Thomas Wiest <twiest@redhat.com> | 2015-06-24 10:41:50 -0400 |
commit | 22d36791e985d0e78f6215bb46c6cd18bd7b719c (patch) | |
tree | f920486e5f372f38ef3d552048b66b37e3840bda /docs | |
parent | 578120137601c060805bcdcea13730573a8a3755 (diff) | |
download | openshift-22d36791e985d0e78f6215bb46c6cd18bd7b719c.tar.gz openshift-22d36791e985d0e78f6215bb46c6cd18bd7b719c.tar.bz2 openshift-22d36791e985d0e78f6215bb46c6cd18bd7b719c.tar.xz openshift-22d36791e985d0e78f6215bb46c6cd18bd7b719c.zip |
added .yml extension to style guide.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/style_guide.adoc | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/style_guide.adoc b/docs/style_guide.adoc index 7dc240f2e..2f89a5fae 100644 --- a/docs/style_guide.adoc +++ b/docs/style_guide.adoc @@ -43,6 +43,20 @@ This is a hard limit and is enforced by the build bot. This check MUST NOT be di == Ansible + +=== Ansible Yaml file extension +''' +[cols="2v,v"] +|=== +| **Rule** +| All Ansible Yaml files MUST have a .yml extension (and NOT .YML, .yaml etc). +|=== + +Ansible tooling (like `ansible-galaxy init`) create files with a .yml extension. Also, the Ansible documentation website references files with a .yml extension several times. Because of this, it is normal in the Ansible community to use a .yml extension for all Ansible Yaml files. + +Example: `tasks.yml` + + === Ansible Global Variables Ansible global variables are defined as any variables outside of ansible roles. Examples include playbook variables, variables passed in on the cli, etc. |