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

guide: extract part of theconfig cmd ref. #340

Closed
1 task done
jorgeorpinel opened this issue May 15, 2019 · 14 comments · Fixed by #4379
Closed
1 task done

guide: extract part of theconfig cmd ref. #340

jorgeorpinel opened this issue May 15, 2019 · 14 comments · Fixed by #4379
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide C: ref Content of /doc/*-reference

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 15, 2019

The Configuration sections is too long for the cmd ref. Probably the best route is to extract the parts of the current cmd ref description and all the config options into a new User Guide, and leave the rest in the cmd ref.

From #331 (review)


UPDATE from #1368 (comment):

It's not a well known or documented feature of DVC, but DVC merges sections with same name from different configs

^ This can be part of the intro or index to the configuration guide.

@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) command-reference type: enhancement Something is not clear, small updates, improvement suggestions labels May 15, 2019
@shcheklein shcheklein changed the title Split up dvc config command ref split up dvc config command ref May 15, 2019
@ryokugyu

This comment was marked as outdated.

@shcheklein

This comment was marked as outdated.

@ryokugyu

This comment has been minimized.

@shcheklein

This comment has been minimized.

@ryokugyu

This comment has been minimized.

@ryokugyu

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Sep 26, 2019

I've updated the issue description to include:

Probably the best route is to extract the parts of the current cmd ref description and all the options into a new User Guide, and leave the rest in the cmd ref.

What do you guys think? Sorry it took so long!

@jorgeorpinel jorgeorpinel changed the title split up dvc config command ref config: split up cmd ref into user guide + cmd ref Sep 26, 2019
@shcheklein
Copy link
Member

@jorgeorpinel yep, agreed. I would start probably by writing User Guide and taking some parts from the commands reference. When it's ready we'll clean the CR sections and put the appropriate links.

@jorgeorpinel

This comment has been minimized.

@ryokugyu

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel jorgeorpinel added help wanted Contributors especially welcome and removed question labels Dec 29, 2019
@jorgeorpinel jorgeorpinel changed the title config: split up cmd ref into user guide + cmd ref cmd ref: extract part of config into user-guide Jan 19, 2020
@jorgeorpinel jorgeorpinel added p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. and removed command-reference help wanted Contributors especially welcome labels Jan 19, 2020
@jorgeorpinel jorgeorpinel changed the title cmd ref: extract part of config into user-guide user-guide: extract part of config into the user guide May 8, 2020
@jorgeorpinel jorgeorpinel changed the title user-guide: extract part of config into the user guide user-guide: extract part of config cmd ref into the user guide May 8, 2020
@jorgeorpinel jorgeorpinel added p1-important Active priorities to deal within next sprints p2-next-quarter and removed p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. p1-important Active priorities to deal within next sprints labels Mar 15, 2022
@jorgeorpinel jorgeorpinel added ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement and removed type: enhancement Something is not clear, small updates, improvement suggestions help wanted Contributors especially welcome labels Mar 30, 2022
@jorgeorpinel jorgeorpinel added the C: ref Content of /doc/*-reference label Mar 30, 2022
@jorgeorpinel
Copy link
Contributor Author

Another important aspect to include, from #1368 (comment) 👍🏼

if we define a remote (name and all settings) in a local config (for security concerns) all other team members have to agree on the url and potentially name for the remote as well.
It's not a well known or documented feature of DVC, but DVC merges sections with same name from different configs...
in the regular .dvc/config
in the local config - .dvc/config.local
...
same idea, but you should be using --system or --global configs
the config behavior could use some documentation

Also relates to #2866

@jorgeorpinel jorgeorpinel removed the ✨ epic Placeholder ticket for multi-sprint direction, use story, improvement label Apr 20, 2022
@jorgeorpinel jorgeorpinel changed the title guide: extract part of config cmd ref into the user guide guide: extract part of theconfig cmd ref. Apr 20, 2022
@jorgeorpinel jorgeorpinel added p1-important Active priorities to deal within next sprints and removed p1-current-quarter labels Jul 9, 2022
@jorgeorpinel jorgeorpinel self-assigned this Oct 13, 2022
@dberenbaum dberenbaum added p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. and removed p1-important Active priorities to deal within next sprints labels Feb 27, 2023
@dberenbaum
Copy link
Contributor

dberenbaum commented Feb 27, 2023

Lowering priority due to lack of resources

jorgeorpinel added a commit that referenced this issue Mar 11, 2023
@jorgeorpinel jorgeorpinel removed the p2-nice-to-have Less of a priority at the moment. We don't usually deal with this immediately. label Mar 11, 2023
dberenbaum pushed a commit that referenced this issue Mar 16, 2023
* guide: add Config guide

per #340

* Include basic remote storage config info and...

and/or link to
https://dvc.org/doc/user-guide/data-management/remote-storage

* Update content/docs/command-reference/config.md

Co-authored-by: Dave Berenbaum <[email protected]>

* Restyled by prettier (#4383)

Co-authored-by: Restyled.io <[email protected]>

* guide: update links to Config info. (#4380)

* guide: Update links to config sections

Previously in the cmd ref, now in a new guide

* guide: some more links related to `dvc config` instances

* guide: update links from `dvc config` (ref) to new guide

* guide: clarify about other config file locations

per #4379 (review)

* guide: refinements

per #4379 (review)
and #4379 (comment)

* Update content/docs/user-guide/project-structure/configuration.md

---------

Co-authored-by: Dave Berenbaum <[email protected]>

---------

Co-authored-by: Dave Berenbaum <[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
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide C: ref Content of /doc/*-reference
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants