Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328

sarthakforwet · 2020-05-21T13:04:09Z

Added references to .dvcignore from other docs and also listed an example in docs of dvc move.

jorgeorpinel · 2020-05-21T19:45:00Z

Hi @sarthakforwet I'll review this ASAP. Please notice that #1329 was open automatically because the formatting of your source code doesn't follow the guidelines explained in https://dvc.org/doc/user-guide/contributing/docs (see dev environment and doc style sections). Please address this meanwhile.

shcheklein · 2020-05-21T21:29:30Z

@sarthakforwet I see a lot of changes! thanks 🙏But from what I get by briefly taking a look at them - it's not exactly what expected in the ticket, and I'm not sure that they are correct to be honest. I know that the ticker itself is not precisely defined, thus what I suggest before we proceed here, let's in the ticket itself write things we want to mention, use case we have in mind for people to be aware, write simple scripts to show those use case. So that we are on the same page + scripts. Closing this for now, we'll reopen it when we have a plan of changes.

sarthakforwet · 2020-05-22T09:22:55Z

Hey, what ticket means? Can you please elaborate it?
Also are you saying to write scripts regarding the changes i have mentioned to justify them?

shcheklein · 2020-05-22T18:24:47Z

Hey, what ticket means?

not sure I got the question

Also are you saying to write scripts regarding the changes i have mentioned to justify them?

no, I mean simple scripts (show cases) in the ticket so that we clearly understand what use cases are we writing about:

vim .dvcignore
// add .DS_Store there
git commit .dvcignore -m "dvc: ignore Mac OS files in outputs and input"

something like this should be enough ^^

let's say we add a mention of .dvcignore to some DVC page - we should have a clear scenario in mind.

jorgeorpinel · 2020-05-23T04:13:03Z

@sarthakforwet hi! For future reference, please link the PR to the original issue in following attempts. I've updated the description here for your ref.

jorgeorpinel · 2020-05-23T04:26:32Z

what I suggest before we proceed here, let's in the ticket itself write things we want to mention, use case we have in mind for people to be aware, write simple scripts to show those use case. So that we are on the same page + scripts

what ticket means?

@sarthakforwet Ivan meant the ticket that this PR attempts to close, #1033

are you saying to write scripts regarding the changes i have mentioned to justify them?

To be extra clear, Ivan is pointing out that the original ticket or issue (#1033) is kind of vague and open to interpretation so that's part of the reason why your changes here were not what we expected. I think I need to work on that issue a little more for it to really be a good-first-issue...

sarthakforwet · 2020-05-23T05:03:49Z

I think changes like below describes relationship of .dvcignore with add and move and these kind of solves some of the checkboxes listed at #1033 ?

jorgeorpinel

Hey @sarthakforwet I left some specific feedback as agreed although I think you may be working on another issue instead? Not sure sorry lost track. If you get back to this, please notice the original issue has more specific checkboxes so you can open a PR to address just one of them and we can go one by one. Some of the text in this PR could be reused possibly.

jorgeorpinel · 2020-05-23T22:57:42Z

content/docs/command-reference/add.md

+To untrack a file or directory just add [patterns](https://git-scm.com/docs/gitignore) (corresponding to the location of file or directory) under `.dvcignore` file.<br> 
+See [.dvcignore](docs/user-guide/.dvcignore) for more details. 


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.

jorgeorpinel · 2020-05-23T23:17:29Z

content/docs/command-reference/commit.md


+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.
+


This note was in a more appropriate place. The paragraph just needed formatting (see docs contrib guide) and also I would not link patterns to the Git website in any of these docs to avoid confusions.

The link href is incorrect though, it's missing a / in the beginning, please run the app locally so you can see and try your changes. See docs contrib guide.

jorgeorpinel · 2020-05-23T23:19:42Z

content/docs/command-reference/move.md

+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.


This also looks good to me, maybe just put it under an H2 heading such as ## Dvcignore effects. Same in other docs.

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.

jorgeorpinel · 2020-05-23T23:23:02Z

content/docs/command-reference/pull.md

+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.


Misisng a space and please don't add <br>s, just regular break lines

Suggested change

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.

DVC might remove ignored files (files listed in `.dvcignore`) upon `dvc run` or `dvc repro`. If they are not produced by a pipeline stage, they can be deleted permanently. See [.dvcignore](docs/user-guide/.dvcignore) for more details.

It also needs formatting (max 80 char lines).

jorgeorpinel · 2020-05-23T23:25:29Z

content/docs/command-reference/push.md

@@ -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.


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 <br> and needs formatting.

sarthakforwet · 2020-05-24T11:08:20Z

@jorgeorpinel Thank you for your review. I am correcting the issues and will soon submit PR's One by One Sequentially with proper formatting.

sarthakforwet added 30 commits May 20, 2020 20:11

Update import-data.md

0be6f03

Update add-files.md

b0f01a5

Update versioning.md

2ba532f

Update pipelines.md

bb1edce

Update define-ml-pipeline.md

9a68cef

Update data-registries.md

c2fe145

Update dvc-files-and-directories.md

0fbf551

Update external-dependencies.md

ec28a1d

Update add.md

af3a1ff

Update checkout.md

afe146c

Update commit.md

980fd31

Update destroy.md

f5775c5

Update init.md

9d04a9b

Update move.md

d33df7e

Update index.md

bfcc276

Update index.md

ae564a6

Update push.md

a57d17a

Update index.md

d2552c8

Update index.md

ed96d47

Update pull.md

31a973e

Update add-files.md

d71fcec

Update add-files.md

9af23c8

Update import-data.md

51b5bfa

Update import-data.md

80ab644

Update define-ml-pipeline.md

1e375c6

Update data-registries.md

03ec69d

Update external-dependencies.md

66da2ea

Update add.md

3fa7974

Update checkout.md

06538a8

Added reference to .dvcignore to checkout.md

987433c

sarthakforwet added 16 commits May 21, 2020 18:07

Added reference to .dvcignore in commit.md

318b225

Added reference to .dvcignore

8a49687

Added reference to .dvcignore

0a67b3b

Added reference to .dvcignore

b791813

Added reference to .dvcignore

8d875c7

Added reference to .dvcignore

22345a2

Added referene to .dvcignore

fc469b2

Added reference to .dvcignore

4ecbc84

Added reference to .dvcignore

3614bce

Added reference to .dvcignore

ac3a99e

Added reference to .dvcignore

75fa027

Added reference to .dvcignore

15cd8d4

Added reference to .dvcignore

e06b0f8

Added reference to .dvcignore

a9caad9

Added reference to .dvcignore

8270449

Added reference to .dvcignore

9bce697

restyled-io bot mentioned this pull request May 21, 2020

Restyle Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1329

Closed

shcheklein closed this May 21, 2020

jorgeorpinel mentioned this pull request May 23, 2020

guide: add more links to the .dvcignore guide from other docs #1033

Closed

8 tasks

jorgeorpinel reviewed May 23, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328

Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328

sarthakforwet commented May 21, 2020 •

edited by jorgeorpinel

Loading

jorgeorpinel commented May 21, 2020

shcheklein commented May 21, 2020

sarthakforwet commented May 22, 2020 •

edited

Loading

shcheklein commented May 22, 2020

jorgeorpinel commented May 23, 2020

jorgeorpinel commented May 23, 2020

sarthakforwet commented May 23, 2020

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

jorgeorpinel May 23, 2020

sarthakforwet commented May 24, 2020

		To untrack a file or directory just add [patterns](https://git-scm.com/docs/gitignore) (corresponding to the location of file or directory) under `.dvcignore` file.<br>
		See [.dvcignore](docs/user-guide/.dvcignore) for more details.


		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.

		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.

	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.
	DVC might remove ignored files (files listed in `.dvcignore`) upon `dvc run` or `dvc repro`. If they are not produced by a pipeline stage, they can be deleted permanently. See [.dvcignore](docs/user-guide/.dvcignore) for more details.

Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328

Fix #1033 user-guide: add more links to the .dvcignore guide from other docs #1328

Conversation

sarthakforwet commented May 21, 2020 • edited by jorgeorpinel Loading

jorgeorpinel commented May 21, 2020

shcheklein commented May 21, 2020

sarthakforwet commented May 22, 2020 • edited Loading

shcheklein commented May 22, 2020

jorgeorpinel commented May 23, 2020

jorgeorpinel commented May 23, 2020

sarthakforwet commented May 23, 2020

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

jorgeorpinel May 23, 2020

Choose a reason for hiding this comment

sarthakforwet commented May 24, 2020

sarthakforwet commented May 21, 2020 •

edited by jorgeorpinel

Loading

sarthakforwet commented May 22, 2020 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading