Review all dvc add examples throughout docs #1255

[sahilbhosale63]

#1255: Reviewed all the dvc add examples throughout docs. This issue is mentioned under Next priorities on GitHub.

[jorgeorpinel]

Fix #1255

Please do not use that special word @sahilbhosale63, because the entire issue would be closed when/if this is merged.

[jorgeorpinel]

Great start. I left some specific comments on what to do in the 2 instances you found (just remove all the output, it will be easier to maintain these docs in the future this way) 👇

Other than that, I think there are other instances of $ dvc add that probably need some updates. Maybe not in the command or it's output themselves, but in related text of code blocks following. HOWEVER, these secondary updates are somewhat out of scope, since there's a separate checkbox in #1255 for that, so we can leave it for another separate PR if you prefer. Let's just double check that there's no other instances that actually need changes in the command itself or its output.

[jorgeorpinel]

Let's just double check that there's no other instances that actually need changes in the command itself or its output.

UPDATE: I looked over the entire 33 instances of $ dvc add and this is what I found:

• /content/docs/command-reference/move.md:36 - the .dvc file that follows it in lines 42-8 needs to be updated (it should be much shorter now).
• content\docs\start\data-versioning.md:36 - git add command in line 46 could be reordered (put .gitignore at the end).
• content\docs\start\data-versioning.md:36 - same
• content\docs\use-cases\shared-development-server.md:82 - isgit add in line 85 missing .gitignore?
• content\docs\use-cases\versioning-data-and-model-files\index.md:46-7 - git add in line 63 could be reordered too.
• content\docs\use-cases\versioning-data-and-model-files\tutorial.md"125/147 - reorder git add in 156. Maybe also put data before model (same in line 235)
• content\docs\user-guide\dvc-files-and-directories.md:305 - probably remove ... line under it, and .dvc file example in lines 314-8 needs update
• content\docs\user-guide\how-to\update-tracked-files.md:51 - is git add in line 52 missing .gitignore?

^ For all these it's necessary to follow the entire example/context in question to determine these questions, and make the necessary updates.

[jorgeorpinel]

Thanks @sahilbhosale63 !