docs: update files/dirs for 1.0 release#1215
Merged
Merged
Conversation
3 tasks
Co-authored-by: Restyled.io <commits@restyled.io>
shcheklein
reviewed
May 3, 2020
| - `.dvc/tmp`: Directory for miscellaneous temporary files | ||
|
|
||
| - `.dvc/tmp/index`: Directory for remote index files that are used for | ||
| optimizing `dvc push/pull/fetch/status -c` operations. |
Contributor
There was a problem hiding this comment.
it creates a link automatically to the commands, better split this into more verbose but clean:
dvc pull -c, dvc push -c etc
efiop
commented
May 3, 2020
efiop
commented
May 3, 2020
shcheklein
approved these changes
May 3, 2020
Contributor
|
Great! Should we create a tag in this repo before any 1.0 changes, so we can release a pdf version of the docs for 0.9? If so, was this the first 1.0-related change? Thanks |
skshetry
reviewed
May 4, 2020
Comment on lines
+42
to
+44
| - `.dvc/tmp/updater`: This file is used store the latest available version of | ||
| DVC. It's used to remind the user to upgrade when the installed version is | ||
| behind. |
Collaborator
There was a problem hiding this comment.
Why do we need to document for .dvc/tmp directory at all?
Contributor
Author
There was a problem hiding this comment.
@skshetry Sure, we could make it a black box, but people will still get nosy and will ask questions. So easier to document it once and for all 🙂
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Per treeverse/dvc#3725
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please chose to allow us to edit your branch when creating the PR.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏