docs: replace `dvc pipeline` with `dvc dag` #1383

efiop · 2020-05-31T23:17:44Z

You may disregard these recommendations if you used the Edit on GitHub button from dvc.org to improve a doc in place.

❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention Fix #issue (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to allow us to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏

shcheklein · 2020-05-31T23:29:29Z

will be merging after 1.0 release probably

calibre-analytics · 2020-05-31T23:29:48Z

You are out of tests

Choose a plan to resume monitoring your Sites and Pull Requests. If you need help, check the Manage Your Plan and Test Usage guide.

shcheklein · 2020-05-31T23:37:46Z

@jorgeorpinel one more thing to the discrepancies list - we probably use dvc pipeline in a few places ... need to check content and replace

efiop · 2020-05-31T23:56:33Z

@shcheklein We do, in a lot of places. I've decided not to touch those because the mapping is not direct and there are a lot of discrepancies with 1.0. For now it will at least redirect to the new command, but we definitely have a lot of stuff to revisit :(

jorgeorpinel

A few minor issues. I can probably take this over when released (just tricky to keep track of open PRs sometimes). Also missing:

grep all instances of dvc pipeline and old link to that ref. and update throughout docs.
per docs: replace dvc pipeline with dvc dag #1383 (comment)

p.s. I did add a checkbox about that in #1255 @shcheklein, for the record.

content/docs/command-reference/dag.md

jorgeorpinel · 2020-06-01T18:03:10Z

content/docs/command-reference/dag.md

+`dvc dag` displays the stages of a pipeline up to the target stage. If `target`
+is omitted, it will show the full project DAG.


Is it possible to have more than one DAG?

Should we call it always "pipeline" or always "DAG" or always "dependency graph"? We currently have a mix of all these everywhere 😕

Yes, 2 DAGs together is 1 DAG too, just with weakly connected components :)

Pipeline is a DAG in which all stages are somehow connected with each other, so it is not quite that. We could call it pipelineS, but dvc add foo is not quite a pipeline strictly speaking. dependency graph sounds as the most correct term, but DAG is a synonym, hence the https://dagshub.com/ :) So we could and probably should use them interchangeably.

This doc is adapted from the old dvc pipeline show so it does suffer from some legacy sentence structure :(

content/docs/command-reference/dag.md

per iterative/dvc.org#1383 (comment)

content/docs/command-reference/dag.md

jorgeorpinel · 2020-06-20T01:51:34Z

OK solved the conflicts in this branch and grep replaced pipeline->dag where needed. Turning this back to you @efiop, please git pull 🙂

content/docs/command-reference/pipeline/index.md

shcheklein · 2020-06-22T04:40:25Z

@jorgeorpinel @efiop what is the status of this?

efiop · 2020-06-23T18:32:40Z

The conflicts are crazy 🙁

efiop · 2020-06-23T18:33:33Z

Will try to get back to it soon. People are asking for it on discord https://discordapp.com/channels/485586884165107732/563406153334128681/725054982629621832

Co-authored-by: Jorge Orpinel <[email protected]>

#1383 (comment)

#1383 (comment) #1383 (comment)

efiop · 2020-06-23T19:03:41Z

@jorgeorpinel @shcheklein Resolved the conflicts, addressed review comments. Please take a look when you'll have time. 🙏

shcheklein · 2020-06-23T19:10:34Z

Looks good to me, but I see some other mentions of the dvc pipeline across docs. Please, do git grep "dvc pipeline" and fix that are obvious for you, and we should create a checkbox in the DVC 1.0 for everything that is left.

efiop · 2020-06-23T19:17:55Z

@shcheklein Did that when initially submitted the PR: #1383 (comment) . But a lot has change since then, taking another look...

efiop · 2020-06-23T19:28:26Z

@shcheklein Indeed, now we have a lot less to update. But still some examples are out-of-date (e.g. push/pull). So I've left them be, but updated others. Edited the checkbox in that epic. We have pipeline -> dag redirects, so we should be fine for now.

shcheklein · 2020-06-24T00:15:46Z

thanks @efiop !

jorgeorpinel · 2020-06-24T07:42:37Z

content/docs/user-guide/running-dvc-on-windows.md

-as pager for the output of `dvc pipeline show`. Windows doesn't have the `less`
-command available however. Fortunately, there is a easy way of installing it via
+as pager for the output of `dvc dag`. Windows doesn't have the less command
+available however. Fortunately, there is a easy way of installing `less` via


`less` first, "it" second, please.

Oh I see this PR is merged. OK I'll do this somewhere else.

jorgeorpinel · 2020-06-24T07:43:33Z

redirects-list.json

  "^/doc/command-reference/lock$                                                          /doc/command-reference/freeze",
  "^/doc/command-reference/unlock$                                                        /doc/command-reference/unfreeze",
+  "^/doc/command-reference/pipeline$                                                      /doc/command-reference/dag",
+  "^/doc/command-reference/pipeline/show$                                                 /doc/command-reference/dag",
+  "^/doc/command-reference/pipeline/list$                                                 /doc/command-reference/dag",


Minor: I'd probably put these above lock/unlock

jorgeorpinel · 2020-06-24T07:49:26Z

content/docs/command-reference/dag.md

+`dvc dag` displays the stages of a pipeline up to the target stage. If `target`
+is omitted, it will show the full project DAG.


I think we shuold start the description with this paragraph though. Since it's now a specific command after all 🙂

Never mind, the short intro is enough. That one needs updating though... Will do.

per #1383 (review) et al.

jorgeorpinel · 2020-06-24T08:55:51Z

Continued in #1496

* cmd ref: more updates on new dag command per #1383 (review) et al. * Update content/docs/command-reference/dag.md Co-authored-by: Ruslan Kuprieiev <[email protected]> * cmd: a few more impros to dag per #1496 (review) and #1496 (review) * cmd: graph -> DAG{linked} in dag intro per #1496 (review) * cmd: DAGs -> graph(s) in dag intro per #1496 (comment) Co-authored-by: Ruslan Kuprieiev <[email protected]>

shcheklein temporarily deployed to dvc-landing-pipeline-da-no2vu4 May 31, 2020 23:18 Inactive

shcheklein approved these changes May 31, 2020

View reviewed changes

efiop mentioned this pull request May 31, 2020

dvc: replace pipeline with dag iterative/dvc#3905

Merged

3 tasks

shcheklein requested a review from jorgeorpinel May 31, 2020 23:37

jorgeorpinel mentioned this pull request Jun 1, 2020

docs: Major DVC 1.x discrepancies #1255

Closed

20 tasks

jorgeorpinel reviewed Jun 1, 2020

View reviewed changes

restyled-io bot mentioned this pull request Jun 1, 2020

Restyle docs: replace dvc pipeline with dvc dag #1386

Closed

jorgeorpinel temporarily deployed to dvc-landing-pipeline-da-no2vu4 June 1, 2020 18:11 Inactive

shcheklein temporarily deployed to dvc-landing-pipeline-da-no2vu4 June 3, 2020 01:24 Inactive

efiop added a commit to iterative/dvc that referenced this pull request Jun 3, 2020

dag: fix help

c03ce4a

per iterative/dvc.org#1383 (comment)

shcheklein temporarily deployed to dvc-landing-pipeline-da-no2vu4 June 3, 2020 01:28 Inactive

efiop self-assigned this Jun 8, 2020

jorgeorpinel assigned jorgeorpinel and unassigned efiop Jun 20, 2020

shcheklein reviewed Jun 20, 2020

View reviewed changes

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

shcheklein reviewed Jun 20, 2020

View reviewed changes

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

jorgeorpinel assigned efiop and unassigned jorgeorpinel Jun 20, 2020

jorgeorpinel mentioned this pull request Jun 20, 2020

term: misc. clarifications #608

Closed

17 tasks

jorgeorpinel reviewed Jun 20, 2020

View reviewed changes

content/docs/command-reference/pipeline/index.md Show resolved Hide resolved

This comment has been minimized.

Sign in to view

docs: replace dvc pipeline with dvc dag

5a8ba59

jorgeorpinel and others added 4 commits June 23, 2020 21:41

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

28cc03f

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

05d40b2

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

1fb7f4a

Co-authored-by: Jorge Orpinel <[email protected]>

add DOT link

a9718a7

efiop force-pushed the pipeline_dag branch from 5622f20 to a9718a7 Compare June 23, 2020 18:41

dag: add old pipeline description

8f46437

#1383 (comment)

efiop added a commit that referenced this pull request Jun 23, 2020

docs: dag: add new example

0d8f42e

#1383 (comment)

docs: dag: add new example

3cbeb07

#1383 (comment) #1383 (comment)

efiop force-pushed the pipeline_dag branch from 0d8f42e to 3cbeb07 Compare June 23, 2020 19:00

shcheklein requested a review from jorgeorpinel June 23, 2020 19:10

replace pipeline with dag

a74f4a1

shcheklein merged commit ccaecda into master Jun 24, 2020

efiop deleted the pipeline_dag branch June 24, 2020 01:05

jorgeorpinel reviewed Jun 24, 2020

View reviewed changes

jorgeorpinel added a commit that referenced this pull request Jun 24, 2020

cmd ref: more updates on new dag command

30220bc

per #1383 (review) et al.

jorgeorpinel mentioned this pull request Jun 24, 2020

cmd ref: more updates on new dag command #1496

Merged

jorgeorpinel mentioned this pull request Jun 26, 2020

dag: rewrite explanation of what pipelines are #1500

Closed

utkarshsingh99 mentioned this pull request Jul 17, 2020

pipeline: links and examples update for 1.x #1584

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: replace `dvc pipeline` with `dvc dag` #1383

docs: replace `dvc pipeline` with `dvc dag` #1383

efiop commented May 31, 2020

shcheklein commented May 31, 2020

calibre-analytics bot commented May 31, 2020

shcheklein commented May 31, 2020

efiop commented May 31, 2020

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel Jun 1, 2020

efiop Jun 2, 2020

jorgeorpinel commented Jun 20, 2020 •

edited

Loading

shcheklein commented Jun 22, 2020

This comment has been minimized.

efiop commented Jun 23, 2020

efiop commented Jun 23, 2020 •

edited

Loading

efiop commented Jun 23, 2020

shcheklein commented Jun 23, 2020

efiop commented Jun 23, 2020

efiop commented Jun 23, 2020 •

edited

Loading

shcheklein commented Jun 24, 2020

jorgeorpinel Jun 24, 2020

jorgeorpinel Jun 24, 2020

jorgeorpinel Jun 24, 2020

jorgeorpinel Jun 24, 2020

jorgeorpinel Jun 24, 2020

jorgeorpinel commented Jun 24, 2020

		`dvc dag` displays the stages of a pipeline up to the target stage. If `target`
		is omitted, it will show the full project DAG.

docs: replace dvc pipeline with dvc dag #1383

docs: replace dvc pipeline with dvc dag #1383

Conversation

efiop commented May 31, 2020

shcheklein commented May 31, 2020

calibre-analytics bot commented May 31, 2020

You are out of tests

shcheklein commented May 31, 2020

efiop commented May 31, 2020

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

jorgeorpinel Jun 1, 2020

Choose a reason for hiding this comment

efiop Jun 2, 2020

Choose a reason for hiding this comment

jorgeorpinel commented Jun 20, 2020 • edited Loading

shcheklein commented Jun 22, 2020

This comment has been minimized.

efiop commented Jun 23, 2020

efiop commented Jun 23, 2020 • edited Loading

efiop commented Jun 23, 2020

shcheklein commented Jun 23, 2020

efiop commented Jun 23, 2020

efiop commented Jun 23, 2020 • edited Loading

shcheklein commented Jun 24, 2020

jorgeorpinel Jun 24, 2020

Choose a reason for hiding this comment

jorgeorpinel Jun 24, 2020

Choose a reason for hiding this comment

jorgeorpinel Jun 24, 2020

Choose a reason for hiding this comment

jorgeorpinel Jun 24, 2020

Choose a reason for hiding this comment

jorgeorpinel Jun 24, 2020

Choose a reason for hiding this comment

jorgeorpinel commented Jun 24, 2020

docs: replace `dvc pipeline` with `dvc dag` #1383

docs: replace `dvc pipeline` with `dvc dag` #1383

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel commented Jun 20, 2020 •

edited

Loading

efiop commented Jun 23, 2020 •

edited

Loading

efiop commented Jun 23, 2020 •

edited

Loading