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

tutorials: confusing code sample and note about .dvc/cache dir #806

Closed
anferico opened this issue Nov 20, 2019 · 5 comments · Fixed by #810
Closed

tutorials: confusing code sample and note about .dvc/cache dir #806

anferico opened this issue Nov 20, 2019 · 5 comments · Fixed by #810
Assignees
Labels
A: docs Area: user documentation (gatsby-theme-iterative) type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@anferico
Copy link

I was following the tutorial at https://dvc.org/doc/tutorials/deep/preparation to start exploring DVC's functionalities. However, when I issue the command dvc init inside the classify/ directory, I don't get the expected results.
In fact, ls -a .dvc should output the following:
./ ../ .gitignore cache/ config
whereas my output is:
./ ../ config .gitignore tmp/
so basically the cache/ directory doesn't get created, but a tmp/ directory does. This wouldn't be a big deal if the tutorial didn't mention that "The .dvc/cache directory is one of the most important parts of any DVC repositories"

@shcheklein
Copy link
Member

@anferico yep, good point .. I think that we switched to creating it on-demand when we actually do some operations with it. @efiop could you confirm?

But the point stays - it's an important part. When you start doing dvc add, dvc run, etc ... you should see the directory.

@shcheklein shcheklein added the A: docs Area: user documentation (gatsby-theme-iterative) label Nov 20, 2019
@shcheklein shcheklein changed the title Failed to initialize DVC repository failed to initialize DVC repository Nov 20, 2019
@shcheklein shcheklein added 🐛 type: bug Something isn't working. type: enhancement Something is not clear, small updates, improvement suggestions tutorials labels Nov 20, 2019
@jorgeorpinel jorgeorpinel changed the title failed to initialize DVC repository tutorials: update deep/preparation code sample and note about .dvc dir Nov 20, 2019
@jorgeorpinel jorgeorpinel changed the title tutorials: update deep/preparation code sample and note about .dvc dir tutorials: confusing code sample and note about .dvc dir in deep/preparation Nov 20, 2019
@jorgeorpinel jorgeorpinel changed the title tutorials: confusing code sample and note about .dvc dir in deep/preparation tutorials: confusing code sample and note about .dvc/cache dir Nov 20, 2019
@jorgeorpinel
Copy link
Contributor

We should def. update the code sample and note though, so it's not confusing. This may affect other docs too. (I think that note is repeated in several places.)

@jorgeorpinel jorgeorpinel removed the 🐛 type: bug Something isn't working. label Nov 20, 2019
@jorgeorpinel jorgeorpinel self-assigned this Nov 20, 2019
@efiop
Copy link
Contributor

efiop commented Nov 20, 2019

@shcheklein I confirm :)

jorgeorpinel added a commit that referenced this issue Nov 22, 2019
note about .dvc/cache dir (listed in .dvc/.gitignore)

for #806
@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Nov 22, 2019

@anferico do you think this version is less confusing? https://dvc-org-pr-810.herokuapp.com/doc/tutorials/deep/preparation

Note that the paragraph starting with "After DVC initialization..." I haven't updated yet because it's repeated in 4 different documents, but I will.

@jorgeorpinel
Copy link
Contributor

@anferico please check my PR #810 if you can. That should solve this confusion. Thanks again for reporting!

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

Successfully merging a pull request may close this issue.

4 participants