guide: external data updates#1735
Conversation
as well as a note about not supporting x metrics/plots per https://discord.com/channels/485586884165107732/485596304961962003/748857709830340698
and reorder cache.{type} options to match std. remote order
per #1735 (review)
et al.
… inc including adding Azure example
|
@jorgeorpinel what is the scope, goal of this PR? can we split it if there are many changes? |
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
set the scope please, split if needed into separate PR if changes are not related
|
All the changes are related the way I see it @shcheklein . The goal was to update the external data docs: https://dvc.org/doc/user-guide/external-dependencies and https://dvc.org/doc/user-guide/managing-external-data which were incomplete and outdated. Theres 2 more files that have small updates directly related to the changes in the aforementioned x deps/outs docs: |
| `dvc remote` for more information on "local remotes".) This will overwrite the | ||
| value provided to `dvc config cache.dir` or `dvc cache dir`. | ||
|
|
||
| - `cache.ssh` - name of an | ||
| [SSH remote to use as external cache](/doc/user-guide/managing-external-data#ssh). |
There was a problem hiding this comment.
This file was just reordered to match the standard sorting of remote types (implemented in recent PRs) — but these cache.{type} options are directly related to external cache setup, and the docs link to each other.
| - [external dependencies](/doc/user-guide/external-dependencies) and | ||
| [external outputs](/doc/user-guide/managing-external-data) (outside of the | ||
| <abbr>workspace</abbr>) are also supported. | ||
| <abbr>workspace</abbr>) are also supported (except metrics and plots). |
There was a problem hiding this comment.
This is part of an important note added to the external outputs doc.
| <details> | ||
|
|
||
| ### Expand to see resulting DVC-file | ||
| ### Expand to see resulting .dvc file |
There was a problem hiding this comment.
we can now use inline code
There was a problem hiding this comment.
Yes, thanks. But actually this may look better? In any case we have a few other similar headers in other docs so I can update them all in a separate small PR if you like how it looks with back quotes more. Lmk please
without .dvc file
with .dvc file
There was a problem hiding this comment.
I don't know, I prefer them highlighted. It feels consistent.
There was a problem hiding this comment.
That PR that introduced code blocks in details also changed existing triggers that have "DVC-file" to ".dvc file".
Here's the details that are like this in master right now
content/docs/user-guide/external-dependencies.md
157:### Expand to see resulting .dvc file
196:### Expand to see resulting .dvc file
The remaining instances of "DVC-file" in headings only exist in the Heartbeat blog posts.
If we decide "DVC-file" looks better, we'll have to change them all back in a PR.
There was a problem hiding this comment.
OK changed for this one file. Will send all the other instances in a separate PR when this one is merged.
There was a problem hiding this comment.
@rogermparent "DVC-file" is a deprecated term 🙂
There was a problem hiding this comment.
My mistake, I get what you mean now!
| ### HDFS | ||
|
|
||
| ```dvc | ||
| # Add HDFS remote to be used as cache location for HDFS files |
There was a problem hiding this comment.
should we put some summary of these comments above of after the code blocks?
There was a problem hiding this comment.
It's all under the ## Examples header now as a numbered list 🙂
Maybe we should make all these H3s into expandable details sections so that you don't have to scroll that much between the numbered list and the actual example?
shcheklein
left a comment
shcheklein
left a comment
There was a problem hiding this comment.
Looks a bit aggressive on removing comments, otherwise good to go!
jorgeorpinel
temporarily deployed
to
dvc-landing-jorge-1wquguk7rhkq
|
Thanks Ivan! Well, I'm going to merge this but lmk about making details sections or a summary of the comments in each H3 (that's kind of repetitive though) and I'll add it to the next PR (coming up). |
* guide: use back quotes in headers per #1735 (comment) * guide: use ```yaml instead of yml (consistency) * guide: capitalize bullet list * intsall: remove unnecessary line in Linux/snap * guide: make H3s into expandable sections in x data docs per #1735 (comment) * cmd: cosmetic updates to cache.{type} config option descriptions
* guide: use back quotes in headers per #1735 (comment) * guide: use ```yaml instead of yml (consistency) * guide: capitalize bullet list * intsall: remove unnecessary line in Linux/snap * guide: make H3s into expandable sections in x data docs per #1735 (comment) * cmd: cosmetic updates to cache.{type} config option descriptions * cmd: std option descs in diff per pending items in #1758 * cmd: small impro to diff * term: review usage of SCM * cmd: remove redundant wording in add * cmd: fix format and typo intro by #1779
4 participants
and other related updates