summaryrefslogtreecommitdiffstats
path: root/docs/index.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:06:49 +0000
commit2fe34b6444502079dc0b84365ce82dbc92de308e (patch)
tree8fedcab52bbbc3db6c5aa909a88a7a7b81685018 /docs/index.md
parentInitial commit. (diff)
downloadansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.tar.xz
ansible-lint-2fe34b6444502079dc0b84365ce82dbc92de308e.zip
Adding upstream version 6.17.2.upstream/6.17.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..df877c6
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,28 @@
+# Ansible Lint Documentation
+
+## About Ansible Lint
+
+Ansible Lint is a command-line tool for linting **playbooks, roles and
+collections** aimed toward any Ansible users. Its main goal is to promote proven
+practices, patterns and behaviors while avoiding common pitfalls that can easily
+lead to bugs or make code harder to maintain.
+
+Ansible lint is also supposed to help users upgrade their code to work with
+newer versions of Ansible. Due to this reason we recommend using it with the
+newest version of Ansible, even if the version used in production may be older.
+
+As any other linter, it is opinionated. Still, its rules are the result of
+community contributions and they can always be disabled based individually or by
+category by each user.
+
+[Ansible Galaxy project](https://github.com/ansible/galaxy/) makes use of this
+linter to compute quality scores for [Galaxy Hub](https://galaxy.ansible.com/)
+contributed content. This does not mean this tool only targets those that want
+to share their code. Files like `galaxy.yml`, or sections like `galaxy_info`
+inside `meta.yml` help with documentation and maintenance, even for unpublished
+roles or collections.
+
+The project was originally started by
+[@willthames](https://github.com/willthames/) and has since been adopted by the
+Ansible Community team. Its development is purely community driven while keeping
+permanent communications with other Ansible teams.