add docs for dvc metrics diff #933

Approved 🎉(check some last comments, feel free to apply in the regular update if needed), though I think it does not solve #921 - just a first basic iteration + a huge (an important) regular update, good conversation about terminology, fixes, etc. Now we need to iterate on the metrics diff doc itself.

…ext) (#962) * add docs for dvc metrics diff * nav: add `metrics diff` to sidebar * cmd ref: typos in `metrics diff` * cmd ref: rewrite `metrics diff` ref and and review related concepts throughout docs e.g. "Git reference", "working tree" * cmd ref: update descs, review options, link all metrics subcmds addresses #933 (review) as well as #933 (review) and #933 (review) * cmd ref: update cmd argument descriptions for `diff` and `metics diff` * metrics diff: big terminology review around the intro of this new command per #933 (review) et al. * term: review usage of "hash", "commit hash", "SHA", and "MD5" per #933 (review) * term: rewrite definition of "workspace" per #933 (review) * cmd ref: change link from `metrics diff` options to `metrics show` per #933 (comment) * cmd ref: update example in `dvc metrics diff` and similar ones per #933 (review) * cmd ref: simplify dvc gc -a option per #933 (review) and #933 (review) * cmd ref: use "reference" more than "revision" in diff per #933 (review) * cmd ref: link term "revision" in diff and `metrics diff` also per #933 (review) * term: put Git ref exapmles before term and link per #933 (review) * cmd ref: friendlier explanation of "tip of default branch" per #933 (review) * cmd ref: use tag name instead of term "the revision" per #933 (review) * term: revert some "revision"->"reference" changes, and related simplifications per #933 (review) * cmd ref: review desc. of `-a` options throughout refs * cmd ref: update diff params per iterative/dvc/pull/3244 * cmd ref: update notes around moving/static Git refs in import and update per #933 (review) * revert workspace glossary entry per #933 (review) * tutorial: use full name of Deep Dive Tutorial in title and links per #933 (review) * user-guide: undo change on "binary" literal for analytics example per #933 (review) * use-cases: avoid term "revision" in data-registries per #933 (review) * term: avoid "checksum" in favor of file "hash" value per #933 (review) * term: SHA hash -> hash (Git commit context) per #962 (comment) Co-authored-by: Ruslan Kuprieiev <[email protected]>

jorgeorpinel · 2020-02-14T03:36:33Z

OK I think #933 (comment) was the only pending thing here actually – now addressed in the latest regular updates PR.

The rest was extracted to #959

per #933 (comment)

* cmd ref: copy edits and improve `move` examples, adding one with `import` related to https://discordapp.com/channels/485586884165107732/485596304961962003/676360262416203776 * tutorials: correct section title in versioning per #933 (comment) * term: review "point" (file hash context) per #552 (comment)

* get/import: update cmd and url arg descs with correct behavior * get/import: update path arg desc as well (See previous commit) * get/imp: udpate help output with simpler terms per #3277 (review) * api: url->URL in a docstring * metrics show: update help output per per iterative/dvc.org#933 (review) * diff: update `diff` and `metrics diff` help desc to match docs per iterative/dvc.org#933 (review) * diff: update autocomplete scripts per #3308 (comment) * diff: update help output again per iterative/dvc.org#933 (review) * diff/metrics diff: update help output yet again per iterative/dvc.org#933 (comment) * term" under X control -> tracked by X

* get/import: update cmd and url arg descs with correct behavior * get/import: update path arg desc as well (See previous commit) * get/imp: udpate help output with simpler terms per #3277 (review) * api: url->URL in a docstring * metrics show: update help output per per iterative/dvc.org#933 (review) * diff: update `diff` and `metrics diff` help desc to match docs per iterative/dvc.org#933 (review) * diff: update autocomplete scripts per #3308 (comment) * diff: update help output again per iterative/dvc.org#933 (review) * diff/metrics diff: update help output yet again per iterative/dvc.org#933 (comment) Co-authored-by: Ruslan Kuprieiev <[email protected]>

efiop changed the title ~~add docs for dvc metrics diff~~ [WIP] add docs for dvc metrics diff Jan 19, 2020

add docs for dvc metrics diff

5f0da08

efiop force-pushed the 921 branch from 340c17e to 5f0da08 Compare January 19, 2020 09:12

efiop changed the title ~~[WIP] add docs for dvc metrics diff~~ add docs for dvc metrics diff Jan 20, 2020

efiop requested a review from jorgeorpinel January 20, 2020 14:41

shcheklein temporarily deployed to dvc-landing-921-comccrlhmerv28 January 24, 2020 21:18 Inactive

nav: add metrics diff to sidebar

9da0661

jorgeorpinel temporarily deployed to dvc-landing-921-comccrlhmerv28 January 24, 2020 22:56 Inactive

jorgeorpinel reviewed Jan 24, 2020

View reviewed changes

This comment has been minimized.

Sign in to view

weekly-digest bot mentioned this pull request Jan 26, 2020

Weekly Digest (19 January, 2020 - 26 January, 2020) #949

Closed

cmd ref: typos in metrics diff

4a1b775

jorgeorpinel temporarily deployed to dvc-landing-921-comccrlhmerv28 January 27, 2020 05:22 Inactive

jorgeorpinel mentioned this pull request Jan 27, 2020

dvc metrics diff iterative/dvc#2995

Closed

jorgeorpinel reviewed Jan 27, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

cmd ref: rewrite metrics diff ref and

8ae2e6d

and review related concepts throughout docs e.g. "Git reference", "working tree"

jorgeorpinel temporarily deployed to dvc-landing-921-comccrlhmerv28 January 27, 2020 17:25 Inactive

jorgeorpinel requested a review from shcheklein January 27, 2020 17:25

This comment has been minimized.

Sign in to view

Merge branch 'master' into 921

041fd22

jorgeorpinel temporarily deployed to dvc-landing-921-comccrlhmerv28 January 27, 2020 17:28 Inactive

shcheklein reviewed Jan 27, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

shcheklein reviewed Jan 27, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

shcheklein reviewed Jan 27, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

shcheklein reviewed Jan 27, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 02:39 Inactive

term: don't use "version of repo/project" when referring to commits

6215bc2

per iterative#933 (comment)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 02:56 Inactive

cmd ref: simlpify note about metrics diff in metrics show

fb459f9

per iterative#933 (review)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 03:49 Inactive

cmd ref: and->and/or in checkout sample of versioning tut

e12e3d7

per iterative#933 (review)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 03:55 Inactive

user-guide: updated analytics details

2b2bfca

per iterative#933 (review)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 04:51 Inactive

cmd ref: restore simpler wording about status -aT desc

fc6d3e9

per iterative#933 (review)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 05:05 Inactive

jorgeorpinel suggested changes Feb 13, 2020

View reviewed changes

public/static/docs/command-reference/metrics/diff.md Outdated Show resolved Hide resolved

cmd ref: correct (again) the short desc for diff and metrics diff

1473ebe

per iterative#933 (comment)

jorgeorpinel temporarily deployed to dvc-landing-921-52xdqc810dd9mc February 13, 2020 05:22 Inactive

jorgeorpinel approved these changes Feb 13, 2020

View reviewed changes

jorgeorpinel requested a review from shcheklein February 13, 2020 05:26

shcheklein approved these changes Feb 13, 2020

View reviewed changes

shcheklein merged commit bd0e250 into iterative:master Feb 13, 2020

jorgeorpinel mentioned this pull request Feb 13, 2020

cmd ref: create doc for metrics diff #921

Closed

jorgeorpinel mentioned this pull request Feb 14, 2020

Regular updates (Feb 10+) #988

Merged

jorgeorpinel added a commit that referenced this pull request Feb 14, 2020

tutorials: correct section title in versioning

be0fd37

per #933 (comment)

jorgeorpinel mentioned this pull request Feb 14, 2020

cmd ref: metrics diff precisions and examples #959

Closed

4 tasks

efiop deleted the 921 branch February 15, 2020 00:30

weekly-digest bot mentioned this pull request Feb 16, 2020

Weekly Digest (9 February, 2020 - 16 February, 2020) #1002

Closed

weekly-digest bot mentioned this pull request Feb 23, 2020

Weekly Digest (16 February, 2020 - 23 February, 2020) iterative/dvc#3387

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add docs for dvc metrics diff #933

add docs for dvc metrics diff #933

efiop commented Jan 19, 2020 •

edited by jorgeorpinel

Loading

efiop commented Jan 22, 2020

jorgeorpinel commented Jan 24, 2020

jorgeorpinel left a comment •

edited

Loading

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

efiop commented Jan 27, 2020

jorgeorpinel left a comment •

edited

Loading

shcheklein left a comment

jorgeorpinel commented Feb 14, 2020

add docs for dvc metrics diff #933

add docs for dvc metrics diff #933

Conversation

efiop commented Jan 19, 2020 • edited by jorgeorpinel Loading

efiop commented Jan 22, 2020

jorgeorpinel commented Jan 24, 2020

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

efiop commented Jan 27, 2020

jorgeorpinel left a comment • edited Loading

Choose a reason for hiding this comment

shcheklein left a comment

Choose a reason for hiding this comment

jorgeorpinel commented Feb 14, 2020

efiop commented Jan 19, 2020 •

edited by jorgeorpinel

Loading

jorgeorpinel left a comment •

edited

Loading

jorgeorpinel left a comment •

edited

Loading