From aab7043d456cf012ad5848c0b02245204257198a Mon Sep 17 00:00:00 2001 From: Ludovic Fernandez Date: Tue, 18 Feb 2020 17:30:05 +0100 Subject: [PATCH] Add information about filename and directory options. --- docs/content/providers/file.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/content/providers/file.md b/docs/content/providers/file.md index 7fac1e95f..090f313b9 100644 --- a/docs/content/providers/file.md +++ b/docs/content/providers/file.md @@ -118,27 +118,35 @@ If you're in a hurry, maybe you'd rather go through the [dynamic configuration]( ### `filename` -Defines the path of the configuration file. +Defines the path to the configuration file. + +!!! warning "" + `filename` and `directory` are mutually exclusive. + The recommendation is to use `directory`. ```toml tab="File (TOML)" [providers] [providers.file] - filename = "dynamic_conf.toml" + filename = "/path/to/config/dynamic_conf.toml" ``` ```yaml tab="File (YAML)" providers: file: - filename: dynamic_conf.yml + filename: /path/to/config/dynamic_conf.yml ``` ```bash tab="CLI" ---providers.file.filename=dynamic_conf.toml +--providers.file.filename=/path/to/config/dynamic_conf.toml ``` ### `directory` -Defines the directory that contains the configuration files. +Defines the path to the directory that contains the configuration files. + +!!! warning "" + `filename` and `directory` are mutually exclusive. + The recommendation is to use `directory`. ```toml tab="File (TOML)" [providers]