guide: add Configuration guide #4379
Conversation
jorgeorpinel
added
A: docs
Link Check ReportThere were no links to check! |
| ### core | ||
|
|
||
| - [`core.remote`](#remote) - name of the default remote storage | ||
|
|
||
| - `core.interactive` - whether to always ask for confirmation before reproducing |
There was a problem hiding this comment.
I just wonder whether these should be hidden in <details> sections, so the page doesn't seem that long.
There was a problem hiding this comment.
Have you tried L2 headers instead of L3 so they all show in the sidebar?
There was a problem hiding this comment.
I guess that would also be better than now, yes. I'd still also consider using hidden sections... Maybe both? U: I tried combining both and it does work (when you click in the title on the right sidebar it scrolls and opens the section). Up to you
There was a problem hiding this comment.
p.s. updated to use both for now, PTAL.
| `.dvc/config` is meant to be tracked by Git and should not contain sensitive | ||
| user info or secrets (passwords, SSH keys, etc). Other | ||
| [config file locations](#config-file-locations) can be used as well. |
There was a problem hiding this comment.
| `.dvc/config` is meant to be tracked by Git and should not contain sensitive | |
| user info or secrets (passwords, SSH keys, etc). Other | |
| [config file locations](#config-file-locations) can be used as well. | |
| `.dvc/config` is meant to be tracked by Git and should not contain sensitive | |
| user info or secrets (passwords, SSH keys, etc). Other | |
| [config file locations](#config-file-locations) are not tracked by Git and can | |
| be used for sensitive info. |
Minor suggestion to be more direct in this explanation.
There was a problem hiding this comment.
Or use what's in the ref: Use --local when in doubt.
There was a problem hiding this comment.
Hmmm, didn't love either suggestion. I updated it in a different way (b7e9672), PTAL.
There was a problem hiding this comment.
What's your goal with this admon? I was trying to make sure that we include enough info so people know where they generally should store sensitive info. I feel like just saying that other locations can be used kind of leaves people hanging.
There was a problem hiding this comment.
Good point. We could move it into the next section (Config file locations)... U: Done
There was a problem hiding this comment.
@jorgeorpinel I'm not seeing an update here. Am I missing something?
There was a problem hiding this comment.
Looks like you pushed to #4380 instead of this PR?
There was a problem hiding this comment.
Anyway, looks good there, thanks!
There was a problem hiding this comment.
Oops. Glad it worked out in the end. Thanks
Co-authored-by: Dave Berenbaum <[email protected]>
Co-authored-by: Restyled.io <[email protected]>
|
My only other Q (other than #4379 (review) above) is whether we should find some more places to link to this guide, like https://dvc.org/doc/install. Either way this (and then #4380) should be mergeable I think 🙂 |
* 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]>
jorgeorpinel
added
the
p1-important
Closes #340.
In review app: https://dvc-org-guide-config-dnq66kjws.herokuapp.com/doc/user-guide/project-structure/configuration