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

user-guide: review "Managing External Data" examples #411

Closed
1 task done
jorgeorpinel opened this issue Jun 5, 2019 · 4 comments
Closed
1 task done

user-guide: review "Managing External Data" examples #411

jorgeorpinel opened this issue Jun 5, 2019 · 4 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Jun 5, 2019

Per request from @MrOutis in iterative/dvc#2092 (comment)

See doc in question: https://dvc.org/doc/user-guide/managing-external-data#examples (SSH)

This part specifically for example may not make sense:

# Add SSH remote to be used as cache location for SSH files
dvc remote add sshcache ssh://[email protected]:/cache

# Tell dvc to use the 'sshcache' remote as SSH cache location
dvc config cache.ssh sshcache

# Add data on SSH directly
dvc add ssh://[email protected]:/mydata

Because the sshcache remote name is never used.

  • Also, the paths used in SSH URIs throughout don't match (:/cache vs :/mydata vs :/home/shared/data.txt).

Related to #143

@jorgeorpinel jorgeorpinel changed the title Revjew SSH external output example in docs review SSH example in "External Outputs" doc Jun 5, 2019
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) 🐛 type: bug Something isn't working. good first issue Good for newcomers user-guide labels Jun 5, 2019
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Aug 17, 2019

Because the sshcache remote name is never used.

I don't think that's correct actually. The remote is registered and then configured as the SSH cache.

The paths are strange though, not only because :/cache vs :/mydata don't match, but because of the way dvc add is used. For example:

# Add data on SSH directly
dvc add ssh://[email protected]:/mydata

@jorgeorpinel jorgeorpinel changed the title review SSH example in "External Outputs" doc review "Managing External Data" example examples Aug 17, 2019
@jorgeorpinel jorgeorpinel changed the title review "Managing External Data" example examples review "Managing External Data" examples Oct 9, 2019
@jorgeorpinel
Copy link
Contributor Author

Another note to add to this document (and to the external dependencies one) is that SSH remote locations (and soon others) now support adding entire directories. See iterative/dvc#1654 (comment).

@jorgeorpinel jorgeorpinel changed the title review "Managing External Data" examples docs: review "Managing External Data" examples Oct 25, 2019
@efiop
Copy link
Contributor

efiop commented Oct 25, 2019

Also now directories are supported for s3 too iterative/dvc#2619

@jorgeorpinel jorgeorpinel added the type: enhancement Something is not clear, small updates, improvement suggestions label Jan 20, 2020
@jorgeorpinel jorgeorpinel changed the title docs: review "Managing External Data" examples user-guide: review "Managing External Data" examples Jan 20, 2020
@jorgeorpinel
Copy link
Contributor Author

I just noticed that this is all done now.

@iesahin iesahin added the C: guide Content of /doc/user-guide label Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: guide Content of /doc/user-guide 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

4 participants