config: reorder and summarize sections (in ref.)#3098
Merged
Conversation
5 tasks
jorgeorpinel
temporarily deployed
to
dvc-org-ref-config-exp-zr8gad8
jorgeorpinel
changed the title
jorgeorpinel
commented
Dec 17, 2021
| <abbr>cache</abbr>. | ||
| - [`exp`](#exp) - options to change the default repo paths assumed by | ||
| `dvc exp init` | ||
| - [`plots`](#plots) - contains an option to set custom HTML templates. |
Contributor
Author
There was a problem hiding this comment.
- Looks like this has to be updated soon per ref: Add
plots.auto_openindvc.config#3101 (review): there are 2 options in that section now.
Contributor
Author
|
Ping @dberenbaum (when you can) |
iesahin
reviewed
Dec 29, 2021
dberenbaum
approved these changes
Dec 29, 2021
Contributor
dberenbaum
left a comment
dberenbaum
left a comment
There was a problem hiding this comment.
LGTM! I left a couple minor formatting suggestions for consistency.
| config file (`.dvc/config` by default), supporting different config options | ||
| within: | ||
|
|
||
| - [`core`](#core) - main section with the general config options |
Contributor
There was a problem hiding this comment.
Suggested change
| - [`core`](#core) - main section with the general config options | |
| - [`core`](#core) - main section with the general config options. |
Contributor
Author
There was a problem hiding this comment.
Not a full sentence 😬
Contributor
Author
There was a problem hiding this comment.
Nor do they complete a stem started before the bullet list
|
|
||
| - [`core`](#core) - main section with the general config options | ||
| - [`remote`](#remote) - sections in the config file that describe particular | ||
| remotes |
Contributor
There was a problem hiding this comment.
Suggested change
| remotes | |
| remotes. |
| - [`cache`](#cache) - contains the options that affect the project's | ||
| <abbr>cache</abbr>. | ||
| - [`exp`](#exp) - options to change the default repo paths assumed by | ||
| `dvc exp init` |
Contributor
There was a problem hiding this comment.
Suggested change
| `dvc exp init` | |
| `dvc exp init`. |
jorgeorpinel
commented
Jan 4, 2022
jorgeorpinel
commented
Jan 4, 2022
Co-authored-by: Restyled.io <commits@restyled.io>
Contributor
Author
|
I don't think the periods are necessary @dberenbaum but please lmk if I'm wrong and I'll rewrite as full sentences. Thanks |
iesahin
pushed a commit
that referenced
this pull request
Apr 11, 2022
* ref: reorder config sections, add summary list with links * ref: move config section summaries to bullet list * ref: rewrite exp section of config * Update content/docs/command-reference/config.md * Update content/docs/command-reference/config.md * Restyled by prettier (#3148) Co-authored-by: Restyled.io <commits@restyled.io> Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com> Co-authored-by: Restyled.io <commits@restyled.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
exp initrelated section