misc. regular updates #1801

jorgeorpinel · 2020-09-23T18:28:43Z

Update status sample outputs (rel=Keep status output format consistents dvc#4490)
Other copy edits around term "import"
Notes about pull/push for imports (fixes sync: mention that fetch and pull re-import data #1792)
Other copy edits
Rewrote section about remote aliases in external dependencies guide

related to treeverse/dvc/pull/4490

content/docs/user-guide/merge-conflicts.md

…tes) per #1792

content/docs/command-reference/get.md

content/docs/user-guide/external-dependencies.md

per #1801 (review)

jorgeorpinel · 2020-09-25T21:22:37Z

content/docs/user-guide/merge-conflicts.md

 ```yaml
-< < < < < < < HEAD
-md5: 263395583f35403c8e0b1b94b30bea32
-=======
-md5: 520d2602f440d13372435d91d3bfa176
-> > > > > > > branch
 frozen: true


@efiop another quick Q: this was added accidentally right? As .dvc files no longer have a top md5 field. Just double checking

@jorgeorpinel This is an import file, so they do have the md5 and so this change is wrong 🙁

OK np I'll revert it.

Why do import .dvc files need a top md5 though? We may need to document this in https://dvc.org/doc/user-guide/dvc-files-and-directories or in the import(-url) refs. at least. Thanks

We probably will be removing it in the future, it has been in discussions for a while now.

Indeed, looks like https://dvc.org/doc/user-guide/dvc-files-and-directories doesn't have imports at all 🙁

per #1801 (review)

jorgeorpinel · 2020-09-26T04:02:00Z

Sorry, this PR got too large somehow (I had an irregular week). But 9/16 files only have small indentation or typo changes. Hopefully it's not too much to review, but lmk if I should split it. Thanks

shcheklein · 2020-09-26T04:19:30Z

content/docs/user-guide/merge-conflicts.md

 < < < < < < < HEAD
    rev_lock: f31f5c4cdae787b4bdeb97a717687d44667d9e62
-=======
+= = = = = = =


they should be w/o spaces - https://wincent.com/wiki/Understanding_Git_conflict_markers ?

The problem is that most IDEs will think it's an actual conflict if we save it like that. Maybe even GitHub or some code analyzers will pick it up as a problem.

And we can't use HTML encoding since it's in a md code block.

shcheklein · 2020-09-26T04:20:03Z

content/docs/user-guide/merge-conflicts.md

+And then `dvc update` the `.dvc` file to download the latest data from its
+original source.
+
+> Note that updating will bring in the latest version of the data found in its


@efiop could you confirm this?

Yes, correct.

content/docs/command-reference/import-url.md

content/docs/user-guide/external-dependencies.md

shcheklein

looks good, some comments to fix, otherwise ready to merge

per #1801 (review)

jorgeorpinel · 2020-09-26T05:12:39Z

Thanks! Merging this but I can do a quick followup if any of the recent comments above require more iterations to be addressed.

jorgeorpinel

A couple things I noticed based on the changes above:

jorgeorpinel · 2020-09-26T05:17:04Z

content/docs/user-guide/external-dependencies.md

+Let's see an example using SSH. First, register and configure the remote:
+
+```dvc
+$ dvc remote add myssh ssh://myserver.com
+$ dvc remote modify --local myssh user myuser
+$ dvc remote modify --local myssh password mypassword
+```


This makes me realize our SSH examples for remote add/modify may be misleading (in other docs) because we sometimes use ssh://user@example.com... when adding, and then mention about modifying the credentials or even show an example of remote modify example user ... but I don't know if that will work correctly with DVC. Need to check...

I tried testing this but can't because of treeverse/dvc#4712.

jorgeorpinel · 2020-09-26T05:19:25Z

content/docs/user-guide/external-dependencies.md

+Now, use an alias to this remote when defining the stage:

 ```dvc


I also realized this doc only uses dvc run to define stages and doesn't show the resulting dvc.yaml files (except for import(-url) examples. Maybe we shouldn't even use dvc run in most of these examples? Since manually writing dvc.yaml is the recommended way.

But then again you can't easily write an external dependency in dvc.yaml ... Hmmm 🤔

per #1801 (review)

per #1801 (comment)

jorgeorpinel added 2 commits September 23, 2020 13:12

Merge branch 'master' into jorge

73e9109

status: update sample outputs

6fc5e8b

related to treeverse/dvc/pull/4490

shcheklein temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 23, 2020 18:29 Inactive

docs: copy edits around term "ipmort"

bd5e462

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 23, 2020 21:09 Inactive

jorgeorpinel commented Sep 23, 2020

View reviewed changes

content/docs/user-guide/merge-conflicts.md Outdated Show resolved Hide resolved

Merge branch 'master' into jorge

1c82664

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 23, 2020 21:12 Inactive

import: add notes about push/pull using original source (not DVC remo…

c75a683

…tes) per #1792

jorgeorpinel requested a review from shcheklein September 23, 2020 21:53

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 23, 2020 21:54 Inactive

jorgeorpinel mentioned this pull request Sep 23, 2020

Document --backup import behaviour #1788

Closed

cmd: better move example titles

ef42cf8

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 23, 2020 22:22 Inactive

shcheklein reviewed Sep 23, 2020

View reviewed changes

content/docs/command-reference/get.md Outdated Show resolved Hide resolved

shcheklein reviewed Sep 23, 2020

View reviewed changes

content/docs/user-guide/external-dependencies.md Outdated Show resolved Hide resolved

shcheklein reviewed Sep 23, 2020

View reviewed changes

content/docs/user-guide/external-dependencies.md Outdated Show resolved Hide resolved

jorgeorpinel added 2 commits September 25, 2020 16:38

Merge branch 'master' into jorge

960b98f

guide: fix import merge section

e4c2c87

per #1801 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 25, 2020 21:17 Inactive

Merge branch 'master' into jorge

79d1ae4

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 25, 2020 21:18 Inactive

jorgeorpinel commented Sep 25, 2020

View reviewed changes

cmd: rewrite description of url and path for get/import

e635905

per #1801 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 25, 2020 21:53 Inactive

guide: remove notes about imports and remote storage in x deps

9b4ea34

per #1801 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 25, 2020 22:03 Inactive

guide: rewrite section about remote aliases in x deps

1e75862

per #1801 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 26, 2020 03:53 Inactive

jorgeorpinel requested a review from shcheklein September 26, 2020 03:54

jorgeorpinel added 2 commits September 25, 2020 23:58

glossary: roll back wrong abbr tag in tooltip

f150ccc

guide: small simplification

0dc8d22

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 26, 2020 03:59 Inactive

shcheklein reviewed Sep 26, 2020

View reviewed changes

content/docs/command-reference/import-url.md Outdated Show resolved Hide resolved

shcheklein reviewed Sep 26, 2020

View reviewed changes

content/docs/user-guide/external-dependencies.md Outdated Show resolved Hide resolved

shcheklein approved these changes Sep 26, 2020

View reviewed changes

cmd: "pull/push to/from" fix

f23fc5c

per #1801 (review)

jorgeorpinel deployed to dvc-landing-jorge-gygjvh75jusb September 26, 2020 04:57 View deployment

guide: hint on the use of remote modify --local for x deps

d16cd33

per #1801 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-gygjvh75jusb September 26, 2020 05:11 Inactive

jorgeorpinel merged commit 11ca7bd into master Sep 26, 2020

jorgeorpinel commented Sep 26, 2020

View reviewed changes

jorgeorpinel added a commit that referenced this pull request Sep 28, 2020

guide: roll back top md5 in import dvc file ex of Merging

debfb47

per #1801 (review)

jorgeorpinel added a commit that referenced this pull request Sep 28, 2020

guide: mention top md5 field for import .dvc files in Metafiles guide

6796b4d

per #1801 (review)

jorgeorpinel mentioned this pull request Sep 28, 2020

guide: top md5 field of import .dvc files (Metafiles) #1818

Merged

jorgeorpinel added a commit that referenced this pull request Feb 4, 2021

remote: review ssh// URLs and auth info.

c965762

per #1801 (comment)

		Now, use an alias to this remote when defining the stage:

		```dvc

misc. regular updates #1801

misc. regular updates #1801

Uh oh!

Conversation

jorgeorpinel commented Sep 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel Sep 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel commented Sep 26, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shcheklein left a comment

Choose a reason for hiding this comment

Uh oh!

jorgeorpinel commented Sep 26, 2020

Uh oh!

jorgeorpinel left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jorgeorpinel commented Sep 23, 2020 •

edited

Loading

jorgeorpinel Sep 26, 2020 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading