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

add a user guide page about the optimization (advanced mode) #265

Closed
6 tasks done
shcheklein opened this issue Apr 24, 2019 · 3 comments · Fixed by #368
Closed
6 tasks done

add a user guide page about the optimization (advanced mode) #265

shcheklein opened this issue Apr 24, 2019 · 3 comments · Fixed by #368
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative)

Comments

@shcheklein
Copy link
Member

shcheklein commented Apr 24, 2019

In the recent DVC release we are changing the way we are linking DVC controlled files with the working space via iterative/dvc#1841, iterative/dvc#1914 and a potentially a few other PRs.

The motivation for this change could be found here: iterative/dvc#1599

This is a major change and affect the user workflow, cache settings, performance, etc. Sometimes is a way that can make users unhappy - since copying is happening.

Things we need to do here:

  • we should write a user guide section about the links (some information can be taken from - the Data files protection dvc#1599);
  • we need to write a section "advanced mode" or "performance optimization" which should be a brief guide on how to switch DVC into using hardlinks, symlinks, etc, what caveats ppl should expect (that it's recommended to use protected mode by default and dvc unprotect in those cases);
  • we should put links to these sections wherever it's appropriate;
  • we should update the config doc - introduce new flags;
  • we should review and update existing mentions of the dvc unprotect;
  • Update a Tracked File section itself should be updated;
@shcheklein shcheklein changed the title Add a user guide page about the optimization (advanced mode) add a user guide page about the optimization (advanced mode) Apr 24, 2019
@shcheklein shcheklein added A: docs Area: user documentation (gatsby-theme-iterative) command-reference type: enhancement Something is not clear, small updates, improvement suggestions and removed get-started type: enhancement Something is not clear, small updates, improvement suggestions labels Apr 24, 2019
@ghost
Copy link

ghost commented May 13, 2019

Related: https://github.com/iterative/dvc/pull/1997/files#r283492357

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 21, 2019

Thanks for merging #345 Ivan. I still have to double check the last 2 check boxes in this issue though. I'll close again when I do so if you don't mind.

UPDATE: Will address in #368

@shcheklein
Copy link
Member Author

oops, Github closed it automatically :)

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)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants