diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/index.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3836198 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,47 @@ +.. _lint_documentation: + +Ansible Lint Documentation +========================== + +About Ansible Lint +`````````````````` + +Ansible Lint is a commandline tool for linting playbooks. Use it to detect behaviors and practices that could potentially +be improved. + +The tool is used by the `Ansible Galaxy project <https://github.com/ansible/galaxy/>`_ to lint and calculate quality scores +for content contributed to the `Galaxy Hub <https://galaxy.ansible.com>`_. + +The project was originally started by `@willthames <https://github.com/willthames/>`_, and has since been +transferred to the Ansible project team. + + +.. toctree:: + :maxdepth: 3 + :caption: Installing + + installing + +.. toctree:: + :maxdepth: 3 + :caption: Usage + + usage + +.. toctree:: + :maxdepth: 3 + :caption: Configuring + + configuring + +.. toctree:: + :maxdepth: 4 + :caption: Rules + + rules + default_rules + +.. toctree:: + :caption: Contributing + + contributing |