From 6bbd302480802d16ed5c9d703fd60bfe20c2136a Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sun, 10 Oct 2021 15:50:59 +0200 Subject: [PATCH] docs: add linkback to possible configuration override options (#231) --- docs/content/configuration/_index.md | 14 +++++++------- docs/content/configuration/defaults.md | 2 ++ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md index d412da2..c3ad2c5 100644 --- a/docs/content/configuration/_index.md +++ b/docs/content/configuration/_index.md @@ -2,15 +2,15 @@ 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) -- global configuration file (this will depend on your operating system) -- folder-based configuration file (.later.yml|.later.yaml|.later) in current working directory +- default configuration (built-in) +- global configuration file (this depends on your operating system) +- folder-based configuration file (`.later.yml|.later.yaml|.later`) in the current working directory - 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. diff --git a/docs/content/configuration/defaults.md b/docs/content/configuration/defaults.md index ff1b1d8..962772d 100644 --- a/docs/content/configuration/defaults.md +++ b/docs/content/configuration/defaults.md @@ -2,6 +2,8 @@ title: Default settings --- +The default configuration is used if no other value is specified. Each option can be [overridden](/configuration/) in several ways. +