mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-25 06:10:43 +00:00
disable spellchecker for 'highlight' shortcodes
This commit is contained in:
parent
a5b3eab603
commit
1b65cb43c8
14
.dictionary
14
.dictionary
@ -1,21 +1,9 @@
|
|||||||
([a-zA-Z0-9]+[_=])+\S+
|
|
||||||
@\S+
|
|
||||||
.py
|
|
||||||
Ansible
|
Ansible
|
||||||
Bott
|
Bott
|
||||||
CLI
|
CLI
|
||||||
Jinja2
|
Jinja2
|
||||||
Kaussow
|
Kaussow
|
||||||
PyPI
|
PyPI
|
||||||
YAML
|
|
||||||
Yaml
|
|
||||||
ansible-.+
|
|
||||||
basename
|
|
||||||
config
|
|
||||||
dir
|
|
||||||
SELinux
|
SELinux
|
||||||
subfolder
|
|
||||||
sudo
|
|
||||||
xoxys
|
xoxys
|
||||||
option1:option2
|
ansible-.+
|
||||||
todo
|
|
||||||
|
@ -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):
|
Changes can be made on different locations which will be processed in the following order (last wins):
|
||||||
|
|
||||||
- default config (build-in)
|
- default configuration (build-in)
|
||||||
- global config file (path depends on your operating system)
|
- global configuration file (path depends on your operating system)
|
||||||
- folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir)
|
- folder-based configuration file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working directory)
|
||||||
- environment variables
|
- environment variables
|
||||||
- CLI options
|
- CLI options
|
||||||
|
@ -5,6 +5,7 @@ title: CLI options
|
|||||||
You can get all available CLI options by running `ansible-doctor --help`:
|
You can get all available CLI options by running `ansible-doctor --help`:
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight Shell "linenos=table" >}}
|
{{< highlight Shell "linenos=table" >}}
|
||||||
$ ansible-doctor --help
|
$ ansible-doctor --help
|
||||||
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v]
|
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v]
|
||||||
@ -28,4 +29,5 @@ optional arguments:
|
|||||||
-q decrease log level
|
-q decrease log level
|
||||||
--version show program's version number and exit
|
--version show program's version number and exit
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
@ -4,6 +4,7 @@ title: Default settings
|
|||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
<!-- markdownlint-disable -->
|
<!-- markdownlint-disable -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight YAML "linenos=table" >}}
|
{{< highlight YAML "linenos=table" >}}
|
||||||
---
|
---
|
||||||
# default is your current working dir
|
# default is your current working dir
|
||||||
@ -38,5 +39,6 @@ exclude_files: []
|
|||||||
# - molecule/
|
# - molecule/
|
||||||
# - files/**/*.py
|
# - files/**/*.py
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
@ -3,6 +3,7 @@ title: Environment Variables
|
|||||||
---
|
---
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight Shell "linenos=table" >}}
|
{{< highlight Shell "linenos=table" >}}
|
||||||
ANSIBLE_DOCTOR_CONFIG_FILE=
|
ANSIBLE_DOCTOR_CONFIG_FILE=
|
||||||
ANSIBLE_DOCTOR_ROLE_DIR=
|
ANSIBLE_DOCTOR_ROLE_DIR=
|
||||||
@ -18,4 +19,5 @@ ANSIBLE_DOCTOR_CUSTOM_HEADER=
|
|||||||
ANSIBLE_DOCTOR_EXCLUDE_FILES=
|
ANSIBLE_DOCTOR_EXCLUDE_FILES=
|
||||||
ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py
|
ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
@ -3,6 +3,7 @@ title: Using docker
|
|||||||
---
|
---
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight Shell "linenos=table" >}}
|
{{< highlight Shell "linenos=table" >}}
|
||||||
docker run \
|
docker run \
|
||||||
-e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \
|
-e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \
|
||||||
@ -15,6 +16,7 @@ docker run \
|
|||||||
-w /doctor \
|
-w /doctor \
|
||||||
xoxys/ansible-doctor
|
xoxys/ansible-doctor
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
{{< hint info >}}
|
{{< hint info >}}
|
||||||
|
@ -4,6 +4,7 @@ title: Using pip
|
|||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
<!-- markdownlint-disable -->
|
<!-- markdownlint-disable -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight Shell "linenos=table" >}}
|
{{< highlight Shell "linenos=table" >}}
|
||||||
# From PyPI as unprivileged user
|
# From PyPI as unprivileged user
|
||||||
$ pip install ansible-doctor --user
|
$ pip install ansible-doctor --user
|
||||||
@ -14,5 +15,6 @@ $ sudo pip install ansible-doctor
|
|||||||
# From Wheel file
|
# 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
|
$ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
@ -6,7 +6,7 @@ title: Usage
|
|||||||
ansible-doctor FOLDER
|
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:
|
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
|
|||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
<!-- prettier-ignore-start -->
|
||||||
<!-- markdownlint-disable -->
|
<!-- markdownlint-disable -->
|
||||||
|
<!-- spellchecker-disable -->
|
||||||
{{< highlight Yaml "linenos=table" >}}
|
{{< highlight Yaml "linenos=table" >}}
|
||||||
# @identifier option1:option2: <value>
|
# @identifier option1:option2: <value>
|
||||||
|
|
||||||
@ -28,12 +29,14 @@ This will be the base result set which is used as data source for every output t
|
|||||||
# @end
|
# @end
|
||||||
docker_registry_password: "secret"
|
docker_registry_password: "secret"
|
||||||
{{< /highlight >}}
|
{{< /highlight >}}
|
||||||
|
<!-- spellchecker-enable -->
|
||||||
<!-- markdownlint-restore -->
|
<!-- markdownlint-restore -->
|
||||||
<!-- prettier-ignore-end -->
|
<!-- prettier-ignore-end -->
|
||||||
|
|
||||||
These list of predefined identifiers is currently available:
|
These list of predefined identifiers is currently available:
|
||||||
|
|
||||||
- @meta
|
|
||||||
- @todo
|
- `@meta`
|
||||||
- @var
|
- `@todo`
|
||||||
- @tag
|
- `@var`
|
||||||
|
- `@tag`
|
||||||
|
Loading…
Reference in New Issue
Block a user