Misc. updates #1615

jorgeorpinel · 2020-07-22T19:47:51Z

Triggered as out-of-scope from other tickets/PRs

more repro updates per repro: 1.x update #1572 (review) +
repro examples per repro: 1.x update #1572 (review)
updates to init to close cmd: explain init dvc nested dvc projects/repos and relationship to --subdir #1638
std. --jobs option description in all refs.
other

per #1572 (comment)

content/docs/command-reference/repro.md

per #1572 (review)

rel #1572 (review)

per #1572 (comment) and #1572 (comment)

per #1572 (comment)

…on of stages

content/docs/command-reference/init.md

shcheklein · 2020-08-05T04:45:22Z

content/docs/command-reference/init.md

-
- Not enough isolation/granularity - commands like `dvc metrics diff`, `dvc dag`
-  and others by default dump all the metrics, all the pipelines, etc.
+- By default, DVC commands like `dvc checkout` and `dvc repro` explore the whole


still, case with not isolated/granular dvc metrics diff seems a bit different than dvc pull - one is mostly about performance, second is about actual output - might resonate with different people.

It's fine though to keep it this way. Not a strong one.

Agree. I changed the last sentence to "This can produce undesirable results and/or be inefficient for large monorepos." to better capture both cases.

yep, but this is a good example of what I meant with implicit vs explicit. undesirable results sounds and reads cool, and one paragraph looks better for sure, but it almost does not mean anything to a reader .. it's hard (or at least takes an effort) to get an example of what does it mean.

again, not a big deal in this case, just want to further explain my thought-process on being explicit if possible.

I see. OK, split into 2 bullets for clarity in be5bc6d.

content/docs/command-reference/init.md

shcheklein · 2020-08-05T04:50:43Z

content/docs/command-reference/init.md


 ```dvc
-$ cd project-A
-$ dvc pull
+project-A       # full DVC + Git repo


why do we need this comment?

Hmmm they are informative. Changed to git init && dvc init in cac92e5. WDYT?

so, that's probably what I don't understand - if we put them they highlight importance of something to my mind, I spend a cycle thinking why did author put a comment here - is .git important in this case? does it change anything?

They do intent to highlight exactly what we mean by nested or not-nested --subdir projects:

Not nested: single-level DVC projects in a Git repo.
Nested: multi-level DVC projects inside (DVC projects inside) DVC/Git repo

This could be also just undetstood by looking at the directories shown (.git, .dvc) but it's not as obvious).

.git still not important here to my mind unless I'm missing something. Nesting would work with --no-scm the same way effectively.

I'm removing these block examples completely for now, and extracting to a following PR...

shcheklein · 2020-08-05T04:52:10Z

content/docs/command-reference/init.md

+that even if the project is tracked by Git, or if Git is initialized in it
+later, DVC will keep operating detached from Git in this project.
+
+> Note that like with nested <abbr>repositories</abbr> and `--subdir` projects,


so, if behavior is the same, do we actually need this note?

Ieally not but yes in the way things are structured now in this ref. This isolation and nested situation got too complicated... I should probably make a separate sub-section to cover it after explaining all the 3 kinds of projects (typical or git-enabled, --subdir, --no-scm).

Can we extract to another issue/PR and get this merged maybe? I have some other changes I also want to throw in on another regular updates PR 😬

Let's remove it then, create a ticket and discuss the changes in advance?

Removed in 9c3ba77. I have all the text already in another branch though so I'll just open a draft PR to discuss, if you don't mind... ⌛

per #1615 (review)

jorgeorpinel · 2020-08-05T04:56:50Z

OMG sorry I linked the other PR to this one 😋 Reopening...

per #1615 (review)

for #1615 (review)

per #1615 (review)

per #1615 (comment)

…/repos in init per #1615 (review)

shcheklein · 2020-08-05T19:14:16Z

I've approved it already a bit ago. Merging ...

jorgeorpinel · 2020-08-05T19:15:18Z

Thanks

* cmd: review repro examples per #1572 (comment) * cmd: fic tyupo in get-url * cmd: updates to repro per #1572 (review) * cmd: rewrite repro -P desc rel #1572 (review) * cmd: simplified and generalize repro targets desc and DVC file mention per #1572 (comment) and #1572 (comment) * cmd: minor update for repro desc wording per #1572 (comment) * term: don't use "synchronize" in the context of checkout * cmd: rewrite Downstream example and added info for sequential execution of stages * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * cmd: Updated Downstream example * Update content/docs/command-reference/repro.md * repro: Updated Downstream example * Update content/docs/command-reference/repro.md * cmd: updated last para for the description of --downstream and improved formatting * cmd: review language of init --subdir * term: revuew usage of "granular", esp. around init --subdir * repro.md: updated Downstream example * cmd: improve init --subdir explanation * cmd: add info about nested subrepos to init * cmd: fix -P option desc. per #1615 (review) * cmd: improve explanation on how --subdir affects commands per #1615 (review) * cmd: simplify nested structures explanation in init per #1615 (comment) * guide: add note aboud `cp` not being a download in external deps per #1643 (review) * cmd: add note about what --cwd means to repro per iterative/dvc#4292 (comment) * guide: nvmd! removing that note in external deps per 42b670f#r41087633 * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * cmd: more small updates to init * Update content/docs/command-reference/repro.md * Update content/docs/command-reference/repro.md * Restyled by prettier * cmd: rewrap metrics diff usage paragraph * term: remove "just" from -j desc in 3 refs per eda27fc * cmd: add command examples to init --subdir use cases per #1615 * cmd: explain nested repo and projects of all kinds outside of --subdir per #1615 (review) * cmd: remove bold names to nested and not-nested structure examples in init --subdir per #1615 (review) * cmd: standardize --jobs option in all refs per #1615 (review) et al. * cmd: add speed note to --jobs desc in all refs. per #1615 (review) * cmd: change versioning command example in init per #1615 (review) * cd: change repo comments in init --subdir examples for #1615 (review) * cmd: improve note on DVC submodules a little for #1615 (review) * cmd: better explain why isolation is important in --subdir bullet per #1615 (review) * cmd: split last --subdir cases explicitly as 2 bullets per #1615 (comment) * cmd: remove most notes and code block examples about nesting projects/repos in init per #1615 (review) * cmd: add basic text about nesting to init * cmd: revert nested block examples back into --subdir per #1661 (review) * cmd: remove new section about nesting to revert more Co-authored-by: sarthakforwet <[email protected]> Co-authored-by: Restyled.io <[email protected]>

cmd: review repro examples

d04f082

per #1572 (comment)

shcheklein temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 22, 2020 19:48 Inactive

jorgeorpinel mentioned this pull request Jul 22, 2020

repro: 1.x update #1572

Merged

jorgeorpinel commented Jul 22, 2020

View reviewed changes

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

sarthakforwet suggested changes Jul 22, 2020

View reviewed changes

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

cmd: fic tyupo in get-url

a201abf

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 22, 2020 21:54 Inactive

jorgeorpinel added 2 commits July 23, 2020 13:47

Merge branch 'master' into jorge

f7d1a7e

cmd: updates to repro

fe8687e

per #1572 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 23, 2020 19:08 Inactive

cmd: rewrite repro -P desc

f3df9d5

rel #1572 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 23, 2020 19:19 Inactive

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 23, 2020 19:36 Inactive

cmd: simplified and generalize repro targets desc and DVC file mention

ebc1560

per #1572 (comment) and #1572 (comment)

jorgeorpinel force-pushed the jorge branch from b1e0a60 to ebc1560 Compare July 23, 2020 19:38

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 23, 2020 19:39 Inactive

This comment has been minimized.

Sign in to view

cmd: minor update for repro desc wording

9a8c977

per #1572 (comment)

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 23, 2020 22:08 Inactive

This comment has been minimized.

Sign in to view

iterative deleted a comment from sarthakforwet Jul 23, 2020

jorgeorpinel marked this pull request as ready for review July 23, 2020 22:29

term: don't use "synchronize" in the context of checkout

c38ce31

jorgeorpinel temporarily deployed to dvc-landing-jorge-pjpofhyw506r July 24, 2020 16:06 Inactive

cmd: rewrite Downstream example and added info for sequential executi…

34217b8

…on of stages

iterative deleted a comment from sarthakforwet Jul 24, 2020

jorgeorpinel and others added 4 commits July 24, 2020 15:15

Update content/docs/command-reference/repro.md

a071b7d

Update content/docs/command-reference/repro.md

edff33e

Update content/docs/command-reference/repro.md

71a5088

cmd: Updated Downstream example

163ed19

shcheklein reviewed Aug 5, 2020

View reviewed changes

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

shcheklein reviewed Aug 5, 2020

View reviewed changes

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

shcheklein reviewed Aug 5, 2020

View reviewed changes

shcheklein closed this in #1658 Aug 5, 2020

cmd: add speed note to --jobs desc in all refs.

5078044

per #1615 (review)

jorgeorpinel reopened this Aug 5, 2020

shcheklein temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 04:57 Inactive

cmd: change versioning command example in init

f176872

per #1615 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 05:03 Inactive

cd: change repo comments in init --subdir examples

cac92e5

for #1615 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 05:04 Inactive

cmd: improve note on DVC submodules a little

d1f9d24

for #1615 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 05:09 Inactive

cmd: better explain why isolation is important in --subdir bullet

8d854a1

per #1615 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 05:15 Inactive

cmd: split last --subdir cases explicitly as 2 bullets

be5bc6d

per #1615 (comment)

jorgeorpinel deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 05:35 View deployment

shcheklein approved these changes Aug 5, 2020

View reviewed changes

cmd: remove most notes and code block examples about nesting projects…

9c3ba77

…/repos in init per #1615 (review)

jorgeorpinel temporarily deployed to dvc-landing-jorge-icpfouh5axbm August 5, 2020 19:13 Inactive

jorgeorpinel requested a review from shcheklein August 5, 2020 19:13

shcheklein merged commit 211c0f9 into master Aug 5, 2020

jorgeorpinel mentioned this pull request Aug 5, 2020

cmd: revert changes to note about nested --subdir repos in init #1661

Merged

jorgeorpinel mentioned this pull request Aug 6, 2020

cmd: simplify project nesting info in init #1664

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Misc. updates #1615

Misc. updates #1615

jorgeorpinel commented Jul 22, 2020 •

edited

Loading

This comment has been minimized.

This comment has been minimized.

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020 •

edited

Loading

shcheklein Aug 5, 2020

jorgeorpinel Aug 5, 2020 •

edited

Loading

jorgeorpinel commented Aug 5, 2020

shcheklein commented Aug 5, 2020

jorgeorpinel commented Aug 5, 2020

Misc. updates #1615

Misc. updates #1615

Conversation

jorgeorpinel commented Jul 22, 2020 • edited Loading

This comment has been minimized.

This comment has been minimized.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 5, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorgeorpinel Aug 5, 2020 • edited Loading

Choose a reason for hiding this comment

jorgeorpinel commented Aug 5, 2020

shcheklein commented Aug 5, 2020

jorgeorpinel commented Aug 5, 2020

jorgeorpinel commented Jul 22, 2020 •

edited

Loading

jorgeorpinel Aug 5, 2020 •

edited

Loading

jorgeorpinel Aug 5, 2020 •

edited

Loading