Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

config: reorder and summarize sections (in ref.) #3098

Merged
merged 6 commits into from
Jan 4, 2022
Merged

config: reorder and summarize sections (in ref.) #3098

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fae33dc
ref: reorder config sections, add summary list with links
jorgeorpinel Dec 15, 2021
34f5ee6
ref: move config section summaries to bullet list
jorgeorpinel Dec 15, 2021
7f809e7
ref: rewrite exp section of config
jorgeorpinel Dec 15, 2021
b2453f3
Update content/docs/command-reference/config.md
jorgeorpinel Jan 4, 2022
29e5eb4
Update content/docs/command-reference/config.md
jorgeorpinel Jan 4, 2022
be1fb78
Restyled by prettier (#3148)
restyled-io[bot] Jan 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 36 additions & 38 deletions content/docs/command-reference/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,26 @@ 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) - main section with the general config options
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [`core`](#core) - main section with the general config options
- [`core`](#core) - main section with the general config options.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a full sentence 😬

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nor do they complete a stem started before the bullet list

- [`remote`](#remote) - sections in the config file that describe particular
remotes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
remotes
remotes.

- [`cache`](#cache) - options that affect the project's <abbr>cache</abbr>
- [`exp`](#exp) - options to change the default repo paths assumed by
`dvc exp init`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`dvc exp init`
`dvc exp init`.

- [`plots`](#plots) - contains an option to set custom HTML templates.
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Dec 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [`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
Expand Down Expand Up @@ -138,16 +151,12 @@ 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.
See `dvc remote add` and `dvc remote modify` for more information.

### cache

This section contains the following options, which affect the project's
<abbr>cache</abbr>:

- `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
Expand Down Expand Up @@ -223,33 +232,32 @@ 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.
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 <abbr>dependency</abbr>.

- `exp.code` - path to your source file or directory.
- `exp.params` - path to your <abbr>parameters</abbr> 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
<abbr>output</abbr>.

- `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](/doc/dvclive) output logs.

- `exp.live` - path to your dvclive outputs.
### plots

### state
- `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.

> 📖 See
> [Internal directories and files](/doc/user-guide/project-structure/internal-files)
> to learn more about the state databases.
### state

- `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
Expand All @@ -267,20 +275,10 @@ 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.

### 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
Expand Down