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

clarify external outputs section #143

Closed
2 tasks
dmpetrov opened this issue Dec 22, 2018 · 12 comments
Closed
2 tasks

clarify external outputs section #143

dmpetrov opened this issue Dec 22, 2018 · 12 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@dmpetrov
Copy link
Member

dmpetrov commented Dec 22, 2018

  • First, https://dvc.org/doc/user-guide/external-outputs describes caches configuration, but not outputs. All the examples describe how to reconfigure cache. Let's rename it to something like Cache Reconfiguration or Setup Cache and let's change the section introduction paragraph accordingly.

  • Local cache reconfiguration is missing. Something like dvc config cache.dir /mnt/cache.
    Also, it is not clear explain why we use cache.{s3, gs, ssh, hdfs} but for local cache we use cache.dir, not cache.local: cache.dir is a shortcut for cache.local.

  • Consolidate everything related to Managing External Data (also including https://dvc.org/doc/user-guide/external-dependencies) under this document, adding an index.md file to do an overview of different approaches and features DVC gives to support it.

@efiop

This comment has been minimized.

@shcheklein shcheklein added type: enhancement Something is not clear, small updates, improvement suggestions A: docs Area: user documentation (gatsby-theme-iterative) user-guide labels Mar 25, 2019
@shcheklein shcheklein changed the title Misleading section name: External Outputs clarify external outputs section Mar 25, 2019
@jorgeorpinel

This comment has been minimized.

@efiop

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel

This comment has been minimized.

@shcheklein

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 20, 2019

Question:

Consolidate everything related to Managing External Data

What about external data sources? I.e. DVC remotes, dvc import and dvc import-url commands, or even more general concepts like "remote location" and "external data source". (from #566) Should we mention any of those in this new consolidated doc, or keep separate?

@shcheklein
Copy link
Member

@jorgeorpinel I think we can definitely mention them to provide a full picture of different options how one can connect data from different sources

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

This is a duplicate of #566 and #657 (comment). Please close 🙂

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) type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

4 participants