Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

cmd ref: double check example-get-started repo examples (tag names) #961

Closed
jorgeorpinel opened this issue Jan 30, 2020 · 2 comments
Closed

cmd ref: double check example-get-started repo examples (tag names) #961

jorgeorpinel opened this issue Jan 30, 2020 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference 🐛 type: bug Something isn't working.

Comments

@jorgeorpinel
Copy link
Contributor

The example-get-started repo changed from 2 tags to 12 at some point, but we didn't update all the examples in cmd ref (or any doc) that use them. More context in #933 (review)
@jorgeorpinel jorgeorpinel added 🐛 type: bug Something isn't working. A: docs Area: user documentation (gatsby-theme-iterative) labels Jan 30, 2020
@jorgeorpinel jorgeorpinel mentioned this issue Jan 30, 2020
Merged
@shcheklein
Copy link
Member

Looks like I was wrong, tags are still here https://github.com/iterative/example-get-started/releases?after=1-initialize . And example get started and all example should use them where appropriate.

@jorgeorpinel
Copy link
Contributor Author

My bad. I thought they were gone because they don't come up in page 1 of https://github.com/iterative/example-get-started/tags

@weekly-digest weekly-digest bot mentioned this issue Feb 2, 2020
Closed
jorgeorpinel added a commit to efiop/dvc.org that referenced this issue Feb 11, 2020
@jorgeorpinel
cmd ref: restore git tag sample output in checkout examples
76cb691 
per iterative#933 (review)
and iterative#961 (comment)
shcheklein pushed a commit that referenced this issue Feb 13, 2020
@efiop @jorgeorpinel
add docs for dvc metrics diff (#933)
bd0e250 
* 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 <[email protected]>
@weekly-digest weekly-digest bot mentioned this issue Feb 16, 2020
Closed
@iesahin iesahin added the C: ref Content of /doc/*-reference label Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference 🐛 type: bug Something isn't working.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@iesahin @jorgeorpinel @shcheklein