From fae33dc33c2898fa1649708ca579c3bc9f47aad7 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 14 Dec 2021 17:35:07 -0700 Subject: [PATCH 1/6] ref: reorder config sections, add summary list with links --- content/docs/command-reference/config.md | 25 ++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 58ed471374..27adb76c72 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -96,8 +96,17 @@ multiple projects or users, respectively. ## Configuration sections -The following config sections are written by this command to the project config -file (in `.dvc/config` by default), and they support the options below: +The following config sections are written by this command to the appropriate +config file (`.dvc/config` by default), supporting different config options +within: + +- [`core`](#core) +- [`remote`](#remote) +- [`cache`](#cache) +- [`exp`](#exp) +- [`plots`](#plots) +- [`state`](#state) +- [`index`](#index) ### core @@ -245,6 +254,12 @@ be overidden explicitly through CLI arguments or through responses in prompts - `exp.live` - path to your dvclive outputs. +### plots + +- `plots.html_template` - sets a + [custom HTML template](/doc/command-reference/plots#html-templates) for + `dvc plots`. Accepts a path relative to the `.dvc/` folder. + ### state > 📖 See @@ -275,12 +290,6 @@ be overidden explicitly through CLI arguments or through responses in prompts files will be stored, by default in `.dvc/tmp/index`. This may be necessary when using DVC on NFS or other mounted volumes. -### plots - -- `plots.html_template` - sets a - [custom HTML template](/doc/command-reference/plots#html-templates) for - `dvc plots`. Accepts a path relative to the `.dvc/` folder. - ## Example: Add an S3 remote, and set it as default > 💡 Before adding an S3 remote, be sure to From 34f5ee63c7970e3f2b77e1a5ea4215c795b8a2f3 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 14 Dec 2021 17:41:56 -0700 Subject: [PATCH 2/6] ref: move config section summaries to bullet list --- content/docs/command-reference/config.md | 47 ++++++++++-------------- 1 file changed, 20 insertions(+), 27 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 27adb76c72..f0cfa3e9d1 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -100,18 +100,23 @@ The following config sections are written by this command to the appropriate config file (`.dvc/config` by default), supporting different config options within: -- [`core`](#core) -- [`remote`](#remote) -- [`cache`](#cache) -- [`exp`](#exp) -- [`plots`](#plots) -- [`state`](#state) -- [`index`](#index) +- [`core`](#core) - main section with the general config options +- [`remote`](#remote) - sections in the config file that describe particular + remotes +- [`cache`](#cache) - contains the options that affect the project's + cache. +- [`exp`](#exp) - overrides default configured workspace paths in + `dvc exp init`. +- [`plots`](#plots) - contains an option to set custom HTML templates. +- [`state`](#state) - see [Internal directories and files][internals] to learn + more about the state database. +- [`index`](#index) - see [Internal directories and files][internals] to learn + more about remote index files. + +[internals]: (/doc/user-guide/project-structure/internal-files) ### core -This is the main section with the general config options: - - `core.remote` - name of the remote storage to use by default. - `core.interactive` - whether to always ask for confirmation before reproducing @@ -147,16 +152,13 @@ This is the main section with the general config options: ### remote -These are sections in the config file that describe particular remotes. They -contain a `url` value, and can also specify `user`, `port`, `keyfile`, -`timeout`, `ask_password`, and other cloud-specific key/value pairs for each -remote. See `dvc remote` for more information. +All `remote` sections contain a `url` value, and can also specify `user`, +`port`, `keyfile`, `timeout`, `ask_password`, and other cloud-specific key/value +pairs for each remote. See `dvc remote add` and `dvc remote modify` for more +information. ### cache -This section contains the following options, which affect the project's -cache: - - `cache.dir` - set/unset cache directory location. A correct value is either an absolute path, or a path **relative to the config file location**. The default value is `cache`, that resolves to `.dvc/cache` (relative to the project @@ -232,9 +234,8 @@ connection settings, and configuring a remote is the way that can be done. ### exp -This section overrides default configured workspace paths in `dvc exp init`, -that helps to avoid repeating these paths if all of your projects share a -similar structure. +Overriding default configured workspace paths in `dvc exp init` helps to avoid +repeating these paths if all of your projects share a similar structure. The section contains following options, which are only used as a default and can be overidden explicitly through CLI arguments or through responses in prompts @@ -262,10 +263,6 @@ be overidden explicitly through CLI arguments or through responses in prompts ### state -> 📖 See -> [Internal directories and files](/doc/user-guide/project-structure/internal-files) -> to learn more about the state databases. - - `state.row_limit` - maximum number of entries in state databases. This affects the physical size of the state files, as well as the performance of certain DVC operations. The default is 10,000,000 rows. The bigger the limit, the @@ -282,10 +279,6 @@ be overidden explicitly through CLI arguments or through responses in prompts ### index -> 📖 See -> [Internal directories and files](/doc/user-guide/project-structure/internal-files) -> to learn more about remote index files. - - `index.dir` - specify a custom location for the directory where remote index files will be stored, by default in `.dvc/tmp/index`. This may be necessary when using DVC on NFS or other mounted volumes. From 7f809e7d3bf30136b6d8dc258738d6b0c3fd5ae0 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Tue, 14 Dec 2021 17:55:00 -0700 Subject: [PATCH 3/6] ref: rewrite exp section of config --- content/docs/command-reference/config.md | 28 +++++++++++------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index f0cfa3e9d1..9431e830b6 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -105,8 +105,8 @@ within: remotes - [`cache`](#cache) - contains the options that affect the project's cache. -- [`exp`](#exp) - overrides default configured workspace paths in - `dvc exp init`. +- [`exp`](#exp) - options to change the default repo paths assumed by + `dvc exp init` - [`plots`](#plots) - contains an option to set custom HTML templates. - [`state`](#state) - see [Internal directories and files][internals] to learn more about the state database. @@ -234,26 +234,24 @@ connection settings, and configuring a remote is the way that can be done. ### exp -Overriding default configured workspace paths in `dvc exp init` helps to avoid -repeating these paths if all of your projects share a similar structure. +Sets the default paths assumed by `dvc exp init`. This can help avoid overriding +them repeatedly with that command's options, for example if all of your +experiments or projects use a similar structure. -The section contains following options, which are only used as a default and can -be overidden explicitly through CLI arguments or through responses in prompts -(in `--interactive` mode). +- `exp.code` - path to your source file or directory dependency. -- `exp.code` - path to your source file or directory. +- `exp.params` - path to your parameters file. -- `exp.data` - path to your data file or directory to track. +- `exp.data` - path to your data file or directory dependency. -- `exp.models` - path to your models file or directory. +- `exp.models` - path to your model/artifact(s) file or directory + output. -- `exp.metrics` - path to your metrics file. +- `exp.metrics` - path to your metrics file output. -- `exp.params` - path to your parameters file. +- `exp.plots` - path to your plots file or directory output. -- `exp.plots` - path to your plots file or directory. - -- `exp.live` - path to your dvclive outputs. +- `exp.live` - path to your [DVCLive](/doc/dvclive) output logs. ### plots From b2453f300c8a2d325be19d805a5bb9f9ab4dcffa Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 3 Jan 2022 22:41:59 -0600 Subject: [PATCH 4/6] Update content/docs/command-reference/config.md --- content/docs/command-reference/config.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 9431e830b6..2698b3ee68 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -103,8 +103,7 @@ within: - [`core`](#core) - main section with the general config options - [`remote`](#remote) - sections in the config file that describe particular remotes -- [`cache`](#cache) - contains the options that affect the project's - cache. +- [`cache`](#cache) - options that affect the project's cache - [`exp`](#exp) - options to change the default repo paths assumed by `dvc exp init` - [`plots`](#plots) - contains an option to set custom HTML templates. From 29e5eb45cbeb448cb3d6b2f370e999133fdf3d49 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Mon, 3 Jan 2022 22:58:26 -0600 Subject: [PATCH 5/6] Update content/docs/command-reference/config.md --- content/docs/command-reference/config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 2698b3ee68..6837f084c6 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -151,9 +151,9 @@ within: ### remote -All `remote` sections contain a `url` value, and can also specify `user`, +All `remote` sections contain a `url` value and can also specify `user`, `port`, `keyfile`, `timeout`, `ask_password`, and other cloud-specific key/value -pairs for each remote. See `dvc remote add` and `dvc remote modify` for more +pairs. See `dvc remote add` and `dvc remote modify` for more information. ### cache From be1fb7878c291411505c0e66794e08f757960786 Mon Sep 17 00:00:00 2001 From: "restyled-io[bot]" <32688539+restyled-io[bot]@users.noreply.github.com> Date: Mon, 3 Jan 2022 22:59:06 -0600 Subject: [PATCH 6/6] Restyled by prettier (#3148) Co-authored-by: Restyled.io --- content/docs/command-reference/config.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/config.md b/content/docs/command-reference/config.md index 6837f084c6..3f0b4a1a31 100644 --- a/content/docs/command-reference/config.md +++ b/content/docs/command-reference/config.md @@ -151,10 +151,9 @@ within: ### remote -All `remote` sections contain a `url` value and can also specify `user`, -`port`, `keyfile`, `timeout`, `ask_password`, and other cloud-specific key/value -pairs. See `dvc remote add` and `dvc remote modify` for more -information. +All `remote` sections contain a `url` value and can also specify `user`, `port`, +`keyfile`, `timeout`, `ask_password`, and other cloud-specific key/value pairs. +See `dvc remote add` and `dvc remote modify` for more information. ### cache