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.

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

Conversation

jorgeorpinel
Copy link
Contributor

  • And especially rewrite the exp init related section

@jorgeorpinel jorgeorpinel mentioned this pull request Dec 15, 2021
5 tasks
@shcheklein shcheklein temporarily deployed to dvc-org-ref-config-exp-zr8gad8 December 15, 2021 00:43 Inactive
@jorgeorpinel jorgeorpinel marked this pull request as ready for review December 15, 2021 00:55
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-ref-config-exp-zr8gad8 December 15, 2021 00:55 Inactive
@jorgeorpinel jorgeorpinel self-assigned this Dec 15, 2021
@jorgeorpinel jorgeorpinel changed the title config: reorder and summarize sections config: reorder and summarize sections (in ref.) Dec 15, 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.
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel Dec 17, 2021

Choose a reason for hiding this comment

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

@jorgeorpinel
Copy link
Contributor Author

Ping @dberenbaum (when you can)

Copy link
Contributor

@dberenbaum dberenbaum left a comment

Choose a reason for hiding this comment

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

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
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


- [`core`](#core) - main section with the general config options
- [`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) - 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`
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`.

@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-ref-config-exp-zr8gad8 January 4, 2022 04:42 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-ref-config-exp-zr8gad8 January 4, 2022 04:58 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-ref-config-exp-zr8gad8 January 4, 2022 04:59 Inactive
@jorgeorpinel jorgeorpinel merged commit a061ac3 into master Jan 4, 2022
@jorgeorpinel jorgeorpinel deleted the ref/config/exp branch January 4, 2022 05:02
@jorgeorpinel
Copy link
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 <[email protected]>

Co-authored-by: restyled-io[bot] <32688539+restyled-io[bot]@users.noreply.github.com>
Co-authored-by: Restyled.io <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants