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

cmd: add to-cache docs #2246

Merged
merged 9 commits into from
Mar 10, 2021
Merged

cmd: add to-cache docs #2246

merged 9 commits into from
Mar 10, 2021

Conversation

isidentical
Copy link
Contributor

@isidentical isidentical commented Mar 1, 2021

Part of #2121

Closes #2220

@shcheklein shcheklein temporarily deployed to dvc-org-to-cache-zmmwawbtziod7 March 1, 2021 07:08 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-org-to-cache-zmmwawbtziod7 March 1, 2021 19:08 Inactive
Comment on lines 404 to 408
tutorial. When it is ready to go, we can add `data.xml` to our cache directly;

```
$ dvc add https://data.dvc.org/get-started/data.xml -o data.xml
```

This comment was marked as resolved.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also not sure about the https://data.dvc.org/get-started/data.xml example... We could keep it hypothetical with some abstract path like /mnt/nfs/raw/data.xml (or some better idea) or ssh://[email protected]/raw/data.xml

Idk, I guess it's not very important but data.dvc.org is kind of an internal company thing (not a secret but still).

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a review with specific suggestions.

I can take this over if needed after your next iteration @isidentical, thanks.

@isidentical
Copy link
Contributor Author

Let's also address #2220 here?

How should we document it though? Separate example (Tutorial: copying datasets in the same workspace) or just a note under the -o option (like this option can also be used to copy data within the same project)?

@shcheklein shcheklein temporarily deployed to dvc-org-to-cache-zmmwawbtziod7 March 2, 2021 13:09 Inactive
@isidentical isidentical requested a review from jorgeorpinel March 3, 2021 08:27
@dberenbaum
Copy link
Contributor

Checking on the status of this @isidentical @jorgeorpinel ?

@jorgeorpinel jorgeorpinel dismissed their stale review March 10, 2021 19:23

Stale review

@jorgeorpinel
Copy link
Contributor

just a note under the -o option

That should be enough for now 👍

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy edits on the example:

content/docs/command-reference/add.md Outdated Show resolved Hide resolved
content/docs/command-reference/add.md Outdated Show resolved Hide resolved
content/docs/command-reference/add.md Outdated Show resolved Hide resolved
content/docs/command-reference/add.md Outdated Show resolved Hide resolved
content/docs/command-reference/add.md Outdated Show resolved Hide resolved
@jorgeorpinel jorgeorpinel merged commit 0e669a9 into master Mar 10, 2021
@isidentical
Copy link
Contributor Author

Thanks @jorgeorpinel!

@jorgeorpinel
Copy link
Contributor

Np! BTW we forgot to update the link in the note in https://dvc.org/doc/user-guide/managing-external-data (currently goes to iterative/dvc#4520). I'll do it separately.

shcheklein pushed a commit that referenced this pull request Mar 14, 2021
* guide: update Ext Data guide link to add to-cache/remote examples
per #2246 (comment)

* ref: config options copy edits

* ref: destroy copy edit
@jorgeorpinel jorgeorpinel deleted the to-cache branch March 19, 2021 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ref: add --out for local targets
5 participants