diff --git a/.dictionary b/.dictionary index f23dd67..339669d 100644 --- a/.dictionary +++ b/.dictionary @@ -1,21 +1,9 @@ -([a-zA-Z0-9]+[_=])+\S+ -@\S+ -.py Ansible Bott CLI Jinja2 Kaussow PyPI -YAML -Yaml -ansible-.+ -basename -config -dir SELinux -subfolder -sudo xoxys -option1:option2 -todo +ansible-.+ diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md index 45e873c..7a01d29 100644 --- a/docs/content/configuration/_index.md +++ b/docs/content/configuration/_index.md @@ -6,8 +6,8 @@ _ansible-doctor_ comes with default settings which should be sufficient for most Changes can be made on different locations which will be processed in the following order (last wins): -- default config (build-in) -- global config file (path depends on your operating system) -- folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir) +- default configuration (build-in) +- global configuration file (path depends on your operating system) +- folder-based configuration file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working directory) - environment variables - CLI options diff --git a/docs/content/configuration/cli.md b/docs/content/configuration/cli.md index cabca2e..67c909f 100644 --- a/docs/content/configuration/cli.md +++ b/docs/content/configuration/cli.md @@ -5,6 +5,7 @@ title: CLI options You can get all available CLI options by running `ansible-doctor --help`: + {{< highlight Shell "linenos=table" >}} $ ansible-doctor --help usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v] @@ -28,4 +29,5 @@ optional arguments: -q decrease log level --version show program's version number and exit {{< /highlight >}} + diff --git a/docs/content/configuration/defaults.md b/docs/content/configuration/defaults.md index 200d188..2ced473 100644 --- a/docs/content/configuration/defaults.md +++ b/docs/content/configuration/defaults.md @@ -4,6 +4,7 @@ title: Default settings + {{< highlight YAML "linenos=table" >}} --- # default is your current working dir @@ -38,5 +39,6 @@ exclude_files: [] # - molecule/ # - files/**/*.py {{< /highlight >}} + diff --git a/docs/content/configuration/env.md b/docs/content/configuration/env.md index 05f7694..b57c981 100644 --- a/docs/content/configuration/env.md +++ b/docs/content/configuration/env.md @@ -3,6 +3,7 @@ title: Environment Variables --- + {{< highlight Shell "linenos=table" >}} ANSIBLE_DOCTOR_CONFIG_FILE= ANSIBLE_DOCTOR_ROLE_DIR= @@ -18,4 +19,5 @@ ANSIBLE_DOCTOR_CUSTOM_HEADER= ANSIBLE_DOCTOR_EXCLUDE_FILES= ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py {{< /highlight >}} + diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md index 05d1622..de905a3 100644 --- a/docs/content/setup/docker.md +++ b/docs/content/setup/docker.md @@ -3,6 +3,7 @@ title: Using docker --- + {{< highlight Shell "linenos=table" >}} docker run \ -e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \ @@ -15,6 +16,7 @@ docker run \ -w /doctor \ xoxys/ansible-doctor {{< /highlight >}} + {{< hint info >}} diff --git a/docs/content/setup/pip.md b/docs/content/setup/pip.md index 0edbe71..72d6540 100644 --- a/docs/content/setup/pip.md +++ b/docs/content/setup/pip.md @@ -4,6 +4,7 @@ title: Using pip + {{< highlight Shell "linenos=table" >}} # From PyPI as unprivileged user $ pip install ansible-doctor --user @@ -14,5 +15,6 @@ $ sudo pip install ansible-doctor # From Wheel file $ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl {{< /highlight >}} + diff --git a/docs/content/usage/_index.md b/docs/content/usage/_index.md index 9eadd0f..9c3e418 100644 --- a/docs/content/usage/_index.md +++ b/docs/content/usage/_index.md @@ -6,7 +6,7 @@ title: Usage ansible-doctor FOLDER ``` -If you don't pass a folder to _ansible-doctor_ your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a subfolder called `tasks` is MUST be an Ansible role! :) +If you don't pass a folder to _ansible-doctor_ your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a sub-directory called `tasks` is MUST be an Ansible role! :) After the successful check, _ansible-doctor_ will try to read some static files into a dictionary: @@ -17,6 +17,7 @@ This will be the base result set which is used as data source for every output t + {{< highlight Yaml "linenos=table" >}} # @identifier option1:option2: @@ -28,12 +29,14 @@ This will be the base result set which is used as data source for every output t # @end docker_registry_password: "secret" {{< /highlight >}} + These list of predefined identifiers is currently available: -- @meta -- @todo -- @var -- @tag + +- `@meta` +- `@todo` +- `@var` +- `@tag`