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

doc: regular updates; New `update` cmd ref #490

Merged

shcheklein merged 25 commits into iterative:master from jorgeorpinel:master

Jul 29, 2019

Contributor

jorgeorpinel commented Jul 16, 2019 •

edited

Loading

Fix #474 and fix #478

jorgeorpinel changed the title ~~Regular updates; And examples for new import, get cmd refs.~~ [WIP] Regular updates; And examples for new import, get cmd refs.

jorgeorpinel changed the title ~~[WIP] Regular updates; And examples for new import, get cmd refs.~~ doc: egular updates; And examples for new import, get cmd refs. [WIP]

jorgeorpinel changed the title ~~doc: egular updates; And examples for new import, get cmd refs. [WIP]~~ doc: regular updates; And examples for new import, get cmd refs. [WIP]

Contributor Author

jorgeorpinel commented Jul 16, 2019 •

edited

Loading

@shcheklein no examples yet but feel free to take a look at the few misc updates already committed here.

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/version.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/commit.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/commit.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/get-started/add-files.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/user-guide/running-dvc-on-windows.md Outdated Show resolved Hide resolved

jorgeorpinel changed the title ~~doc: regular updates; And examples for new import, get cmd refs. [WIP]~~ doc: regular updates; New update cmd ref; Add examples for new import, get cmd refs. [WIP]

jorgeorpinel changed the title ~~doc: regular updates; New update cmd ref; Add examples for new import, get cmd refs. [WIP]~~ doc: regular updates; New update cmd ref; Add examples for new import, get, update cmd refs. [WIP]

This comment has been minimized.

Sign in to view

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/update.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/update.md Outdated Show resolved Hide resolved

This was referenced Jul 20, 2019

syntax: review bullet point lists throughout docs #491

Closed

output: remove a couple more "(s)" left iterative/dvc#2299

Merged

This comment has been minimized.

Sign in to view

jorgeorpinel mentioned this pull request

term: review usage of "source" iterative/example-repos-dev#5

Merged

jorgeorpinel commented

View reviewed changes

static/docs/commands-reference/get.md Outdated Show resolved Hide resolved

jorgeorpinel referenced this pull request


          cmd ref: add get example, and related docs; and update "cache" glos…

9cc98d9

…sary entry

shcheklein reviewed

View reviewed changes

static/docs/commands-reference/get.md Outdated Show resolved Hide resolved

shcheklein temporarily deployed to dvc-org-pr-490

July 24, 2019 07:47

Inactive

jorgeorpinel temporarily deployed to dvc-org-pr-490

July 24, 2019 08:11

Inactive

jorgeorpinel temporarily deployed to dvc-org-pr-490

July 24, 2019 08:14

Inactive

shcheklein reviewed

View reviewed changes

static/docs/user-guide/contributing-documentation.md Outdated Show resolved Hide resolved

shcheklein reviewed

View reviewed changes

static/docs/user-guide/contributing-documentation.md Outdated Show resolved Hide resolved

shcheklein requested changes

View reviewed changes

Member

shcheklein left a comment

So, a few comments left. I kinda lost already what is the major focus of this PR to be honest :). What are the core things that are left to be done? get, update + examples? anythings else?

jorgeorpinel temporarily deployed to dvc-org-pr-490

July 25, 2019 18:54

Inactive

jorgeorpinel temporarily deployed to dvc-org-pr-490

July 25, 2019 19:58

Inactive

jorgeorpinel mentioned this pull request

lock: mention that dvc update is now also setting locked: True #478

Closed

jorgeorpinel added 19 commits

July 28, 2019 18:47


          cmd ref: remove "(s)" and similar from command sample outputs...

3ffa64e

Per changes in iterative/dvc#2281
and iterative/dvc#2299


          term: "initial data" -> "raw data"

6e8f58e

Per #490 (review)


          cmd ref: add update ref and changes in related commands

61c4996

For #474


          syntax: remove ; from bullet points that aren't full sentences

bbc53d8

per #490 (review)


          update: rewrite command short desc

773dfbe

per #490 (review)


          update: remove "(s)"s

4f52401

per #490 (review)


          update: add cmd ref link to side menu!

af1ce92


          cmd ref: add get example, and related docs; and update "cache" glos…

…sary entry


          get: update example...

d7d10fc

Addressing feedback to #490 (comment)


          user-guide: update external-outputs.md wording and terminology

6f76e46


          win: improve notes about POSIX options and

6d8b854

remove term "console" in favor of "terminal" in all docs


          user-guide: update contributing guides with bullet styles, and

other small improvements.

Mainly per #491 (comment)


          win: improve intro to Windows issue workarounds

7bf102e

per #490 (comment)


          lock: mention that imported stages are locked by default

1a064b1

for #478


          lock: mention that dvc unlock is safe for import stages

3a9051e

per #478 (comment)


          get: update example to mention deployment of binary files

4f2d35e

per #490 (comment)


          user-guide: contributing-documentation updates per...

d476807

per PR #490 feedback round 3


          updte Windows performance guide

90c871a

per #490 (review)


          lock: update info about import stages, update, and repro

4ffe63a

per #490 (review)

jorgeorpinel temporarily deployed to dvc-org-pr-490

July 29, 2019 00:48

Inactive


          get: Remove : from md file

00d663b

per #490 (comment)

jorgeorpinel commented

View reviewed changes

static/docs/commands-reference/get.md Outdated Show resolved Hide resolved

jorgeorpinel deployed to dvc-org-pr-490

July 29, 2019 00:51

View deployment

Contributor Author

jorgeorpinel commented Jul 29, 2019

@shcheklein all feedback addressed, and sorry late re:

...What are the core things that are left to be done? get, update + examples? anythings else?

add dvc update cmd ref (cmd ref: add dvc update #474)
lock: mention that dvc update is now also setting locked: True (lock: mention that dvc update is now also setting locked: True #478)
create examples for dvc import and dvc get cmd refs (cmd ref: advanced examples for import (and get) #487)

what else are we missing to merge this?

The last bullet. Finishing the examples. I guess I should extract that yet to another PR...

jorgeorpinel changed the title ~~doc: regular updates; New update cmd ref; Add examples for new import, get, update cmd refs. [WIP]~~ doc: regular updates; New update cmd ref

Contributor Author

jorgeorpinel commented Jul 29, 2019

OK, PR title and description updated. Let's leave the "Add examples for new import, get, update cmd refs." part for another PR @shcheklein? 🙂

shcheklein approved these changes

View reviewed changes

shcheklein merged commit bc444e0 into iterative:master

Member

shcheklein commented Jul 29, 2019

@jorgeorpinel done! agreed, let's move examples to another PR

Contributor Author

jorgeorpinel commented Jul 30, 2019

Moved to #509

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet