Browse Source

fix docs formatting

pull/13/head
Robert Kaussow 2 years ago
parent
commit
a5b3eab603
  1. 1
      .dictionary
  2. 2
      .markdownlint.yml
  3. 12
      docs/content/configuration/_index.md
  4. 4
      docs/content/configuration/cli.md
  5. 2
      docs/content/configuration/defaults.md
  6. 2
      docs/content/configuration/env.md
  7. 1
      docs/content/setup/_index.md
  8. 3
      docs/content/setup/docker.md
  9. 3
      docs/content/setup/pip.md
  10. 18
      docs/content/usage/_index.md

1
.dictionary

@ -11,7 +11,6 @@ YAML
Yaml
ansible-.+
basename
cli
config
dir
SELinux

2
.markdownlint.yml

@ -2,3 +2,5 @@
default: True
MD013: False
MD041: False
MD004:
style: dash

12
docs/content/configuration/_index.md

@ -2,12 +2,12 @@
title: Configuration
---
*ansible-doctor* comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs.
_ansible-doctor_ comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs.
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)
* environment variables
* cli options
- 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)
- environment variables
- CLI options

4
docs/content/configuration/cli.md

@ -2,8 +2,9 @@
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 -->
{{< highlight Shell "linenos=table" >}}
$ ansible-doctor --help
usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v]
@ -27,3 +28,4 @@ optional arguments:
-q decrease log level
--version show program's version number and exit
{{< /highlight >}}
<!-- prettier-ignore-end -->

2
docs/content/configuration/defaults.md

@ -2,6 +2,7 @@
title: Default settings
---
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
{{< highlight YAML "linenos=table" >}}
---
@ -38,3 +39,4 @@ exclude_files: []
# - files/**/*.py
{{< /highlight >}}
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

2
docs/content/configuration/env.md

@ -2,6 +2,7 @@
title: Environment Variables
---
<!-- prettier-ignore-start -->
{{< highlight Shell "linenos=table" >}}
ANSIBLE_DOCTOR_CONFIG_FILE=
ANSIBLE_DOCTOR_ROLE_DIR=
@ -17,3 +18,4 @@ ANSIBLE_DOCTOR_CUSTOM_HEADER=
ANSIBLE_DOCTOR_EXCLUDE_FILES=
ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py
{{< /highlight >}}
<!-- prettier-ignore-end -->

1
docs/content/setup/_index.md

@ -1,4 +1,3 @@
---
title: Setup
---

3
docs/content/setup/docker.md

@ -1,8 +1,8 @@
---
title: Using docker
---
<!-- prettier-ignore-start -->
{{< highlight Shell "linenos=table" >}}
docker run \
-e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \
@ -15,6 +15,7 @@ docker run \
-w /doctor \
xoxys/ansible-doctor
{{< /highlight >}}
<!-- prettier-ignore-end -->
{{< hint info >}}
**Info**\

3
docs/content/setup/pip.md

@ -1,8 +1,8 @@
---
title: Using pip
---
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
{{< highlight Shell "linenos=table" >}}
# From PyPI as unprivileged user
@ -15,3 +15,4 @@ $ sudo pip install ansible-doctor
$ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl
{{< /highlight >}}
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

18
docs/content/usage/_index.md

@ -6,15 +6,16 @@ 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 subfolder 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:
* defaults/main.yml
* meta/main.yml
- defaults/main.yml
- meta/main.yml
This will be the base result set which is used as data source for every output template. Without any work, you will get at least a documentation about available variables and some meta information. Theses basic information can be expanded with a set of available annotations. In general, an annotation is a comment with an identifier. This identifier is followed by colon separated options and ends with a value.
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
{{< highlight Yaml "linenos=table" >}}
# @identifier option1:option2: <value>
@ -28,10 +29,11 @@ This will be the base result set which is used as data source for every output t
docker_registry_password: "secret"
{{< /highlight >}}
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
These list of predefined identifiers is currently available:
* @meta
* @todo
* @var
* @tag
- @meta
- @todo
- @var
- @tag

Loading…
Cancel
Save