Dvc.org: user-guide: extract part of `config` cmd ref into the user guide
See https://dvc.org/doc/commands-reference/config
The Configuration sections part of the document is particularly long. We could split this page into several, similar to https://dvc.org/doc/commands-reference/remote or others that are currently separated based on their sub-commands.
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.
From https://github.com/iterative/dvc.org/pull/331#pullrequestreview-236975854
jorgeorpinel
All 12 comments
@shcheklein anyone working on it?
if not please assign me this issue.
ryokugyu
on 23 May 2019
@ryokugyu no, but let's hold on for a while. We are still deciding on the exact structure. Are you looking for something next to contribute?
shcheklein
on 23 May 2019
@shcheklein yes, i am looking for something to contribute.
ryokugyu
on 23 May 2019
How about this one - https://github.com/iterative/dvc.org/issues/306 ? It's a good one, with a nice description and really valuable. Just mention that you are working on it if you decide to take it. Thanks :)
shcheklein
on 23 May 2019
sure, let me dig it. i will need some help for this.
I am working on it.
ryokugyu
on 23 May 2019
@shcheklein is the structure decided?
ryokugyu
on 14 Jun 2019
@ryokugyu no, not yet. @jorgeorpinel has simplified the config section significantly, so this is issue not that pressing now.
shcheklein
on 14 Jun 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
on 26 Sep 2019
@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.
shcheklein
on 26 Sep 2019
@ryokugyu still around/interested?
jorgeorpinel
on 26 Sep 2019
@jorgeorpinel Still around 馃槃 Was busy with placement session, got placed today only! 馃樅 Let's work on this.
ryokugyu
on 27 Sep 2019
All yours @ryokugyu ! Please lmk if you need any more details. You can also find me on Discord as jorgeorpinel.
p.s. congrats on your placement!
jorgeorpinel
on 27 Sep 2019
Related issues
utkarshsingh99
路
3Comments
dashohoxha
路
4Comments
efiop
路
4Comments
efiop
路
4Comments
efiop
路
4Comments
Most helpful comment
@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.