github/ansible-later
0
0
Fork 0
mirror of https://github.com/thegeeklab/ansible-later.git synced 2024-11-28 07:40:36 +00:00
Code Issues Projects Releases Wiki Activity

docs: add linkback to possible configuration override options (#231)

Browse Source
This commit is contained in:
Robert Kaussow 2021-10-10 15:50:59 +02:00 committed by GitHub
parent be161c5053
commit 6bbd302480
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/content/configuration/_index.md
View File

@ -2,15 +2,15 @@
title: Configuration title: Configuration
--- ---
ansible-later comes with some default settings which should be sufficient for most users to start, but you can adjust most settings to your needs. ansible-later ships with some default settings that should be sufficient for most users to get started, but you can customize settings to suit your needs.
Changes can be made in a YAML configuration file or through CLI options which will be processed in the following order (last wins): Changes can be made in a YAML configuration file or via CLI options, which are processed in the following order (last wins):
- default configuration (build-in) - default configuration (built-in)
- global configuration file (this will depend on your operating system) - global configuration file (this depends on your operating system)
- folder-based configuration file (.later.yml|.later.yaml|.later) in current working directory - folder-based configuration file (`.later.yml|.later.yaml|.later`) in the current working directory
- CLI options - CLI options
Be careful! YAML Attributes will be overwritten while lists in any configuration file will be merged. Please note that YAML attributes are overwritten while YAML lists are merged in any configuration files.
To make it easier to review a single file e.g. for debugging purpose, ansible-later will ignore `exclude_files` and `ignore_dotfiles` options. To simplify single file linting, e.g. for debugging purposes, ansible-later ignores the `exclude_files` and `ignore_dotfiles` options when only one file is passed to the CLI.

2
docs/content/configuration/defaults.md
View File

@ -2,6 +2,8 @@
title: Default settings title: Default settings
--- ---
The default configuration is used if no other value is specified. Each option can be [overridden](/configuration/) in several ways.
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
<!-- spellchecker-disable --> <!-- spellchecker-disable -->