Add gitlablint support (#3042)

1 files changed, 47 insertions, 0 deletions

diff --git a/doc/ale-yaml.txt b/doc/ale-yaml.txt
index 9733990e..b3450b87 100644
--- a/doc/ale-yaml.txt
+++ b/doc/ale-yaml.txt
@@ -281,4 +281,51 @@ g:ale_yaml_yamllint_options                       *g:ale_yaml_yamllint_options*
 
 
 ===============================================================================
+gitlablint                                                  *ale-yaml-gitlablint*
+
+Website: https://github.com/elijah-roberts/gitlab-lint
+
+
+Installation
+-------------------------------------------------------------------------------
+
+Install yamllint in your a virtualenv directory, locally, or globally: >
+
+  pip3 install gitlab_lint        # After activating virtualenv
+  pip3 install --user gitlab_lint # Install to ~/.local/bin
+  sudo pip3 install gitlab_lint   # Install globally
+
+See |g:ale_virtualenv_dir_names| for configuring how ALE searches for
+virtualenv directories.
+
+Is recommended to use |g:ale_pattern_options| to enable this linter so it only
+applies to 'gitlab-ci.yml' files and not all yaml files:
+>
+  let g:ale_pattern_options = {
+  \   '.gitlab-ci\.yml$': {
+  \       'ale_linters': ['gitlablint'],
+  \   },
+  \}
+<
+
+Options
+-------------------------------------------------------------------------------
+
+g:ale_yaml_gitlablint_executable               *g:ale_yaml_gitlablint_executable*
+                                               *b:ale_yaml_gitlablint_executable*
+  Type: |String|
+  Default: `'gll'`
+
+  This variable can be set to change the path to gll.
+
+
+g:ale_yaml_gitlablint_options                     *g:ale_yaml_gitlablint_options*
+                                                  *b:ale_yaml_gitlablint_options*
+  Type: |String|
+  Default: `''`
+
+  This variable can be set to pass additional options to gll.
+
+
+===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: