term: use "hash" in MD5 "checksum" context & Git commit contexts #962
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
and review related concepts throughout docs e.g. "Git reference", "working tree"
addresses #933 (review) as well as #933 (review) and #933 (review)
This was referenced Jan 30, 2020
jorgeorpinel
changed the title
jorgeorpinel
changed the title
jorgeorpinel
added a commit
to efiop/dvc.org
that referenced
this pull request
Feb 12, 2020
may change the decision in that other PR.
jorgeorpinel
commented
Feb 12, 2020
There was a problem hiding this comment.
@shcheklein to help review, here are the main types of changes in this PR:
jorgeorpinel
changed the title
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
shcheklein
pushed a commit
that referenced
this pull request
Feb 13, 2020
* 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: revert "hash"->"checksum" in this PR per #933 (comment) * cmd ref: "revision"->"commit" in get ref per #933 (review) * cmd ref: use correct tag names in checkout examples and double check they still work per #933 (review) * diff: remove backquotes adound "HEAD" same as in core repo per iterative/dvc#3244 (review) * cmd ref: don't use link to git reference doc per #933 (comment) * cmd ref: don't use term "revision" in diff, prefer "commit" per #933 (review) * cmd ref: no need for word "specific" (or "SHA") in get/import per #933 (review) * cmd ref: update "project"->"workspace" term and example intros in `dvc install` per #933 (review) * docs: 2 misc updates per #933 (review) and #933 (review) * tutorials: update model->"data or model" per #933 (review) et al. * cmd ref: fixed link to `metrics diff` and updated mention of it in `metrics show` per #933 (review) and #933 (review) and #933 (review) * get-started: typo in pipelines chapter * cmd ref: rewrite paragraph about fixed revision import stages in `update` per #933 (review) * cmd ref: rewrite p about `repro` rewriting artifacts in cache per #933 (review) * cmd ref: rephrase and split p about what to compare and about targets in `status` per #933 (review) * cmd ref: reorg last part of repro desc * cmd ref: restore `git tag` sample output in checkout examples per #933 (review) and #961 (comment) * cmd ref: small rewording around tag names * cmd ref: `metrics diff` and `diff` intro updates per #933 (review) and #933 (review) * term: use "version" instead of "revision" in `import` cmd ref per #933 (comment) * cmd ref: updates to `metrics diff` (and `diff`) descriptions per https://dvc.org/doc/command-reference/status and #933 (review) and #933 (review) * cmd ref: change "ref" -> "rev" per iterative/dvc/pull/3299 and #933 (review) * cmd ref: "revision"->"version" in a couple more docs per #933 (review) * cmd ref: simplify note about `metrics diff` in `metrics show` per #933 (review) * cmd ref: use descriptive exampe-get-started repo tags in `get` examples per #933 (review) * term: "commit hash"->"commit SHA hash" to match #962 but may change the decision in that other PR. * cmd ref: improve -a adn -c option descs per #933 (review) * cmd ref: remove p about --targets option in metrics diff per #933 (review) * cmd ref: rewrite pa bout fixed revisions/re-importing in `update` per #933 (review) * tutorials: use and instead of data "or" models in versioning tut per #933 (review) and #933 (review) * user-guide: restore bullet about `git` in analytics per #933 (review) * you don't usually merge tags per #933 (review) * term: don't use "version of repo/project" when referring to commits per #933 (comment) * cmd ref: simlpify note about metrics diff in metrics show per #933 (review) * cmd ref: and->and/or in checkout sample of versioning tut per #933 (review) * user-guide: updated analytics details per #933 (review) * cmd ref: restore simpler wording about status -aT desc per #933 (review) * cmd ref: correct (again) the short desc for diff and metrics diff per #933 (comment) Co-authored-by: Jorge Orpinel <jorgeorpinel@users.noreply.github.com>
|
@jorgeorpinel need to rebase/merge |
and update diff examples
Merged
|
|
Ready for review @shcheklein. |
shcheklein
approved these changes
Feb 13, 2020
|
@jorgeorpinel awesome! thanks 🙏 |
jorgeorpinel
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please don't review me yet,
I'm a draft PR.I will be ready for review after #933 is merged.Fixes #552