Update dvc root command reference motivation and examples by jeremydesroches · Pull Request #1637 · treeverse/dvc.org

jeremydesroches · 2020-07-29T12:57:35Z

Updates motivation and examples. See issue #404.

jorgeorpinel · 2020-07-29T15:57:40Z

please double-check my formatting and style

That's checked automatically by Github and Restyled (shown in the bottom PR summary). You can see all the checks in that section of the PR (inside "test", specifically yarn format-check). These should also be run locally automatically if you setup the dev env as explained in our docs contrib guide. Please lmk i fyou have questions about any of that.

jorgeorpinel

Hey Jeremy. Thanks for the PR.

I haven't checked the examples yet but the description didn't fully convince me.

I left specific comments ☝️

…into cmdroot

jeremydesroches · 2020-07-30T03:28:00Z

Thanks Jorge. Made changes based on your feedback and left comments open.

jorgeorpinel

Few more questions on the description. Thanks

jorgeorpinel · 2020-07-30T03:56:42Z

@jeremydesroches please check #404 (comment) before continuing here 🙏

jorgeorpinel

I noticed you added Examples @jeremydesroches. Thanks, I'll review them. But please first make sure the old ones (first 2) are "actionable and meaningful. It's should be easy to run commands to see the results", per #404

jeremydesroches · 2020-07-30T07:48:18Z

I noticed you added Examples @jeremydesroches. Thanks, I'll review them. But please first make sure the old ones (first 2) are "actionable and meaningful. It's should be easy to run commands to see the results", per #404

I reviewed the existing two examples before adding the new ones.

The first example is still meaningful and actionable because it's important to show that dvc root returns a relative reference when and where it's run.

I adjusted the second example to make it more a meaningful and useful (while keeping it simple). The updated version uses dvc root to specify the output of a dvc get command, while working from a subdirectory.

jorgeorpinel

Left some more comments above ☝️

And a review of the Examples below 👇

jorgeorpinel · 2020-07-30T16:21:30Z

+## Example: Build reusable paths
+
+Build reusable paths to dependencies, scripts, or <abbr>data artifacts</abbr>
+from separate stages and subdirectories.
+
+```dvc
+$ cd more_stages/
+$ dvc run -n process_data \
+          -d data.in \
+          -d $(dvc root)/process_data.py \


OK... I think what we need is a shell script that generates a dvc.yaml file instead of another dvc run example. Not required for this PR, so if you're not so familiar with Linux shell just leave it out for now please. Thanks

I removed this for now.

I looked into some related issues (#615) and examples of scripts.

These make sense within the scripting use case but instead of adding a (complicated) example that builds out a full set of stages, it would help to have the team vet a smaller example that fits the recommended usage.

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

jorgeorpinel

OK this is ready I think. I'll just commit my couple pending suggestions and merge this.

Clarifies motivation and description, adds relevant examples

8260191

jeremydesroches changed the title ~~Clarifies motivation and description, adds relevant examples~~ Clarifies dvc root motivation and description, adds relevant examples Jul 29, 2020

jeremydesroches changed the title ~~Clarifies dvc root motivation and description, adds relevant examples~~ Fix #404: Clarifies dvc root motivation and description, adds relevant examples Jul 29, 2020

jorgeorpinel reviewed Jul 29, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel reviewed Jul 29, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel reviewed Jul 29, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel reviewed Jul 29, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel suggested changes Jul 29, 2020

View reviewed changes

Returned to single paragraph, adjusts style to comments

ec65309

restyled-io Bot mentioned this pull request Jul 30, 2020

Restyle Fix #404: Clarifies dvc root motivation and description, adds relevant examples #1639

Closed

jeremydesroches added 3 commits July 30, 2020 10:54

Returned to single paragraph, adjusts style to comments

844f281

Merge branch 'cmdroot' of https://github.com/jeremydesroches/dvc.org …

cae263c

…into cmdroot

Fixes my merge mistake

3fa33d5

jorgeorpinel suggested changes Jul 30, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md

Comment thread content/docs/command-reference/root.md Outdated

Comment thread content/docs/command-reference/root.md Outdated

Removes repeated references to dvc root from examples

7a630b5

jeremydesroches changed the title ~~Fix #404: Clarifies dvc root motivation and description, adds relevant examples~~ Update dvc root command reference motivation and description, add examples Jul 30, 2020

Adds "root directory" to short intro

f0ef6e8

jorgeorpinel mentioned this pull request Jul 30, 2020

cmd ref: review root ref to be aligned with other commands #404

Closed

4 tasks

jorgeorpinel changed the title ~~Update dvc root command reference motivation and description, add examples~~ Update dvc root command reference motivation and description, review examples Jul 30, 2020

jorgeorpinel changed the title ~~Update dvc root command reference motivation and description, review examples~~ Update dvc root command reference motivation and examples Jul 30, 2020

jorgeorpinel reviewed Jul 30, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel reviewed Jul 30, 2020

View reviewed changes

jeremydesroches added 2 commits July 30, 2020 15:23

Adds command name and splits description to two paragraphs

8952e4e

removes extra spacing from examples

8bd6c61

jorgeorpinel reviewed Jul 30, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

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

6dc5f64

This comment has been minimized.

Sign in to view

jorgeorpinel reviewed Jul 30, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel suggested changes Jul 30, 2020

View reviewed changes

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

8474156

Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>

jorgeorpinel temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 03:20 Inactive

Removes extra examples, updates example titles and descriptions

9c82fc8

shcheklein temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 04:13 Inactive

Updates description to expand scripting use case

b05473b

shcheklein temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:01 Inactive

jorgeorpinel reviewed Jul 31, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

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

f005507

jorgeorpinel temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:23 Inactive

jorgeorpinel reviewed Jul 31, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

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

f8b08e6

jorgeorpinel temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:31 Inactive

jorgeorpinel reviewed Jul 31, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel reviewed Jul 31, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

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

a7d0f27

jorgeorpinel temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:35 Inactive

jorgeorpinel reviewed Jul 31, 2020

View reviewed changes

Comment thread content/docs/command-reference/root.md Outdated

jorgeorpinel approved these changes Jul 31, 2020

View reviewed changes

jorgeorpinel added 2 commits July 31, 2020 00:39

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

070cf40

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

9496822

jorgeorpinel requested a deployment to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:39 Abandoned

jorgeorpinel temporarily deployed to dvc-landing-cmdroot-de5w9at1p1 July 31, 2020 05:39 Inactive

jorgeorpinel merged commit cb5f4d6 into treeverse:master Jul 31, 2020

jeremydesroches deleted the cmdroot branch July 31, 2020 08:24

jorgeorpinel mentioned this pull request Jan 6, 2021

doc: change run mentions to dvc.yaml or stage add + repro #2076

Closed

7 tasks

Conversation

jeremydesroches commented Jul 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jorgeorpinel commented Jul 29, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

jeremydesroches commented Jul 30, 2020

Uh oh!

jorgeorpinel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorgeorpinel commented Jul 30, 2020

Uh oh!

Uh oh!

jorgeorpinel left a comment

Choose a reason for hiding this comment

Uh oh!

jeremydesroches commented Jul 30, 2020

Uh oh!

Uh oh!

This comment has been minimized.

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorgeorpinel Jul 30, 2020

Choose a reason for hiding this comment

Uh oh!

jeremydesroches Jul 31, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jorgeorpinel left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jeremydesroches commented Jul 29, 2020 •

edited

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel left a comment •

edited

Loading