Merge pull request #3172 from 0xMH/patch-1

More docs for beginners to use cloudformation linter

1 files changed, 34 insertions, 2 deletions

diff --git a/doc/ale-cloudformation.txt b/doc/ale-cloudformation.txt
index 59c6af06..9724403b 100644
--- a/doc/ale-cloudformation.txt
+++ b/doc/ale-cloudformation.txt
@@ -7,8 +7,40 @@ cfn-python-lint                             *ale-cloudformation-cfn-python-lint*
 
 cfn-python-lint is a linter for AWS CloudFormation template file.
 
-https://github.com/awslabs/cfn-python-lint
+Website: https://github.com/awslabs/cfn-python-lint
 
+Installation
+-------------------------------------------------------------------------------
+
+
+Install cfn-python-lint using either pip or brew: >
+
+`pip install cfn-lint`. If pip is not available, run
+`python setup.py clean --all` then `python setup.py install`.
+
+ Homebrew (macOS):
+
+`brew install cfn-lint`
+
+<
+Configuration
+-------------------------------------------------------------------------------
+
+To get cloudformation linter to work on only CloudFormation files  we must set
+the buffer |filetype| to yaml.cloudformation.
+This causes ALE to lint the file with linters configured for cloudformation and
+yaml files.
+
+Just put:
+
+>
+
+ au BufRead,BufNewFile *.template.yaml set filetype=yaml.cloudformation
+
+<
+
+on `ftdetect/cloudformation.vim`
+
+This will get both cloudformation and yaml linters to work on any file with `.template.yaml` ext.
 ===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
-