ref: improve add/import* to-cache/remote info and examples

[jorgeorpinel]

From relatively recent discussions

Related:

• Clo/ses config: incorrect system config path #2032

• document plots diff/show --open flag #2293

• Addresses Example for dvc add --to-remote #2172 (review)

• Make ref: get/import/list updates #2317 reviewable when this is merged.

[jorgeorpinel]

Just one Q on a fix to the import ref. Cc @efiop in case you're around (I'll double check this myself tmr if not so no worries). Thanks

[jorgeorpinel]

This was wrong right? import-url states the opposite.

[pmrowla]

import and import-url have different behavior, the original docs for each command were correct

[jorgeorpinel]

Interestinggggg 🤔 OK will roll back, thanks! ✔️

[jorgeorpinel]

I wonder if we need a full to-cache example in import-url (like in https://dvc.org/doc/command-reference/add#example-transfer-to-the-cache).

[isidentical]

import-url doesn't have the to-cache ability, but rather work on its own (like you just import an URL with it and it puts it to your cache, but not in a chunked way).

[jorgeorpinel]

Ah, good point. But then maybe we should explain about the chunking (transferring) a bit more... I'll review again ⌛

[jorgeorpinel]

But with --to-cache the chinked transfer does happen, right @isidentical ? Just double checking. Already updated in c393212, PTAL.

[shcheklein]

@jorgeorpinel please split this into 3-4 PRs. It has too many things at once. Makes it hard to review.

[isidentical]

import-url doesn't have the to-cache ability, but rather work on its own (like you just import an URL with it and it puts it to your cache, but not in a chunked way).

[jorgeorpinel]

OK @shcheklein sorry about that. I removed the changes to config and plots from here (stashed for now). Everything else is the same change (updated PR title too).

[jorgeorpinel]

@shcheklein on the example titles, I changed them again after thinking about it:

add:

• Example: External data (to-cache)
• Example: --to-remote usage (--to-remote)

Word "Adding" left out for consistency with previous examples e.g. "Example: Single file" but no strong opinion. Could also start with "Tracking".

import:

• Example: --to-remote usage (--to-remote)

Cc @isidentical @dberenbaum in case you have ideas 🙂