-
Notifications
You must be signed in to change notification settings - Fork 409
Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328
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
Changes from all commits
0be6f03
b0f01a5
2ba532f
bb1edce
9a68cef
c2fe145
0fbf551
ec28a1d
af3a1ff
afe146c
980fd31
f5775c5
9d04a9b
d33df7e
bfcc276
ae564a6
a57d17a
d2552c8
ed96d47
31a973e
d71fcec
9af23c8
51b5bfa
80ab644
1e375c6
03ec69d
66da2ea
3fa7974
06538a8
987433c
318b225
8a49687
0a67b3b
b791813
8d875c7
22345a2
fc469b2
4ecbc84
3614bce
ac3a99e
75fa027
15cd8d4
e06b0f8
a9caad9
8270449
9bce697
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -70,6 +70,8 @@ force-update the [DVC-files](/doc/user-guide/dvc-file-format) and save data to | |
| cache. They are still useful, but keep in mind that DVC can't guarantee | ||
| reproducibility in those cases. | ||
|
|
||
| Note that [patterns](https://git-scm.com/docs/gitignore) listed in `.dvcignore` are not updated as a result of `dvc commit` as they are not currently tracked by DVC. See [.dvcignore](docs/user-guide/.dvcignore) for more details. | ||
|
|
||
|
Comment on lines
72
to
+74
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This note was in a more appropriate place. The paragraph just needed formatting (see docs contrib guide) and also I would not link
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link href is incorrect though, it's missing a |
||
| ## Options | ||
|
|
||
| - `-d`, `--with-deps` - determines files to commit by tracking dependencies to | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -71,6 +71,17 @@ outs: | |
| md5: c8263e8422925b0872ee1fb7c953742a | ||
| path: other.csv | ||
| ``` | ||
| Note that when we try to use `dvc move` over a file whose pattern matches one of the patterns listed in `.dvcignore`, it would raise an error because that DVC-file was not tracked by DVC. | ||
|
|
||
| ```dvc | ||
| $ dvc add data.csv | ||
| $ echo data.* >> .dvcignore | ||
| $ dvc move data.csv other.csv | ||
| ERROR: failed to move 'data.csv' -> 'other.csv' - Unable to find DVC-file with output 'data.csv' | ||
|
|
||
| Having any troubles? Hit us up at https://dvc.org/support, we are always happy to help! | ||
| ``` | ||
| See [.dvcignore](docs/user-guide/.dvcignore) for more details. | ||
|
Comment on lines
+74
to
+84
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This also looks good to me, maybe just put it under an H2 heading such as
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually it's probably best without header and also without example. Just a very short note should do the trick here. We just want users to be aware of .dvcignore, not to explain it in every command ref. |
||
|
|
||
| ## Options | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -56,6 +56,9 @@ After a data file is in cache, `dvc pull` can use OS-specific mechanisms like | |||||||
| reflinks or hardlinks to put it in the workspace without copying. See | ||||||||
| `dvc checkout` for more details. | ||||||||
|
|
||||||||
| Note that when you do `dvc pull` then the missing files whose corresponding DVC-files matches with the DVC-files in remote storage will be downloaded. But if a DVC-file is listed under `.dvcignore` then its corresponding file won't be downloaded.<br> | ||||||||
| See [.dvcignore](docs/user-guide/.dvcignore) for more details. | ||||||||
|
Comment on lines
+59
to
+60
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Misisng a space and please don't add
Suggested change
It also needs formatting (max 80 char lines). |
||||||||
|
|
||||||||
| ## Options | ||||||||
|
|
||||||||
| - `-a`, `--all-branches` - determines the files to download by examining | ||||||||
|
|
||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -70,6 +70,8 @@ backward from the target [stage files](/doc/command-reference/run), through the | |
| corresponding [pipelines](/doc/command-reference/pipeline), to find data files | ||
| to push. | ||
|
|
||
| Note that as `dvc push` uploads tracked files and directories to remote storage, it won't upload files and directories listed under `.dvcignore`.<br> See [.dvcignore](docs/user-guide/.dvcignore) for more details. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are you sure this is the case? Even if the data was tracked before adding it to .dvcignore? If so this note is OK, just again: no |
||
|
|
||
| ## Options | ||
|
|
||
| - `-a`, `--all-branches` - determines the files to upload by examining DVC-files | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding a dvcignore ref in this doc is def. needed but here you're just appending at the end of the examples. Please read the page (rendered in the website), check the structure, and find a better place to add this ref.
Adding an add example specific to dvcignore would also be nice.