Skip to content

cmd ref: dvc add 1.0 update#1411

Merged
shcheklein merged 46 commits into
masterfrom
1.0/add
Jun 11, 2020
Merged

cmd ref: dvc add 1.0 update#1411
shcheklein merged 46 commits into
masterfrom
1.0/add

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel commented Jun 9, 2020 •
edited
Loading

Steals some of Ruslan's work from #1387

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. 🙏

jorgeorpinel and others added 30 commits May 31, 2020 15:53
@jorgeorpinel
cmd ref: add note that move creates dirs
8030c46
@jorgeorpinel
cmd ref: improve structure of add ref desc.
5bffb49
@jorgeorpinel
grammar: add some commas
431ffc0
@jorgeorpinel
term: checksum -> hash value in dvcignore guide
3f2d554
@jorgeorpinel
style: lower case bullet text
86b8f62
@jorgeorpinel
Merge branch 'master' into 2020-05-31
b75f314
@jorgeorpinel
cmd ref: remove some redundancy in metrics index
47ad311
@jorgeorpinel
cmd ref: update plots refs synopsis and descriptions
2f1e09c 
per treeverse/dvc/issues/3924 et al.
@dmpetrov
Add plots modify cmd
3a723a0
@jorgeorpinel
Merge branch 'master' into 2020-05-31
bc54b22
@jorgeorpinel
Merge branch '2020-05-31' of github.com:iterative/dvc.org into 2020-0…
177de9b 
…5-31
@jorgeorpinel
typo: CSV->csv
f59eea9
@jorgeorpinel
term: working tree -> workspace
c73f7c0 
per treeverse/dvc/pull/3914
@jorgeorpinel
cmd ref: couple improvements to add ref
140608c 
per #1382 (review)
and #1382 (review)
@jorgeorpinel
Update config/prismjs/dvc-commands.js
0028b53
@jorgeorpinel
cmd ref: update plots modify description
8e572a5
@jorgeorpinel
cmd ref: add plots modify to nav, with a few more improvements
434fe96
@jorgeorpinel
cmd ref: plots --show-json -> --show-vega
5108e14 
per treeverse/dvc#3891 (comment)
@dmpetrov
rename x-lab to x-label
fba18c3
@jorgeorpinel
Merge branch 'master' into 2020-05-31
a75dda2
@jorgeorpinel
cmd ref: review descriptions of plots index, show, and diff
30493ab
@jorgeorpinel
cmd ref: review and update old plots cmds options
d33aecc 
per treeverse/dvc#3948 et al.
@jorgeorpinel
cmd ref: a couple more option updates
e385a02 
per #1382 (review)
@jorgeorpinel
cmd ref: emphasize add works with any large file/dir
22b648c 
per #1382 (review)
@jorgeorpinel
cmd ref: updae plots modify top half (definition, description)
f3cba9c 
per #1382 (review) al.
@jorgeorpinel
cmd ref: improve all plot cmd option descriptions
532184b
@jorgeorpinel
Update content/docs/command-reference/plots/modify.md
4d9cd71
@jorgeorpinel
cmd ref: review examples (mainly images) in plots modify
791dbd2 
per #1382 (comment) et al.
@jorgeorpinel
Merge branch '2020-05-31' of github.com:iterative/dvc.org into 2020-0…
697ab77 
…5-31
@jorgeorpinel
cmd ref: rephrase info about how data arrays are injected to plot tem…
3eb3858 
…plates

per #1382 (review)
@shcheklein shcheklein temporarily deployed to dvc-landing-1-0-add-hwtygum2op June 9, 2020 00:52 Inactive
@jorgeorpinel jorgeorpinel mentioned this pull request Jun 9, 2020
Merged
jorgeorpinel
jorgeorpinel commented Jun 9, 2020
View reviewed changes
Comment thread content/docs/command-reference/add.md
@jorgeorpinel jorgeorpinel marked this pull request as ready for review June 9, 2020 01:26
@jorgeorpinel jorgeorpinel requested a review from shcheklein June 9, 2020 01:26
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-1-0-add-hwtygum2op June 9, 2020 01:26 Inactive
@jorgeorpinel jorgeorpinel mentioned this pull request Jun 9, 2020
Closed
20 tasks
jorgeorpinel
jorgeorpinel commented Jun 9, 2020
View reviewed changes
Comment thread content/docs/command-reference/add.md Outdated
jorgeorpinel added a commit that referenced this pull request Jun 10, 2020
@jorgeorpinel
user guide: reinstate info about meta fields and
ead834a 
improve info on comments for DVC files&dirs guide
per #1411 (comment)
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-1-0-add-hwtygum2op June 11, 2020 18:12 Inactive
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-1-0-add-hwtygum2op June 11, 2020 18:20 Inactive
Base automatically changed from 2020-05-31 to master June 11, 2020 19:28
@jorgeorpinel jorgeorpinel temporarily deployed to dvc-landing-1-0-add-hwtygum2op June 11, 2020 21:36 Inactive
shcheklein
shcheklein reviewed Jun 11, 2020
View reviewed changes
Comment thread content/docs/command-reference/add.md
usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [-f <filename>]
targets [targets ...]
usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [--external]
[-f <filename>] targets [targets ...]
Copy link
Copy Markdown
Contributor

@shcheklein shcheklein Jun 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this has changed in 1.0 - it's --file now

Copy link
Copy Markdown
Contributor Author

@jorgeorpinel jorgeorpinel Jun 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, will update...

Copy link
Copy Markdown
Contributor Author

@jorgeorpinel jorgeorpinel Jun 12, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extracted to #1426, please assign a priority - very recent change.

shcheklein
shcheklein approved these changes Jun 11, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's fine with me, but I'm a bit lost with these changes, at least with the name of a PR - quite a few changes here, but almost all of them are not related to 1.0 (and we actually didn't include some 1.0 related changes we made to dvc add at the same time)

Again, let's move forward (don't forget to update -f everywhere)

@shcheklein shcheklein merged commit 64182e2 into master Jun 11, 2020
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Jun 12, 2020

name of a PR - quite a few changes here, but almost all of them are not related to 1.0 (and we actually didn't include some 1.0 related changes we made to dvc add at the same time)

All the examples were reviewed with 1.0 and I also reviewed the whole description to see it's still current.

Other than -f did you notice any other 1.0 change I missed? Thanks

@shcheklein
Copy link
Copy Markdown
Contributor

shcheklein commented Jun 12, 2020

Other than -f did you notice any other 1.0 change I missed? Thanks

don't remember from the top of my head, the easiest way is to run dvc add --help :)

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Jun 12, 2020

-f wasn't included because it wasn't there when I did this changes, that PR was merged 2 days ago no docs issue/PR was started by core team: treeverse/dvc/pull/4004

I did notice this and left a message in the PR

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Jun 12, 2020

I ran -h at the time of making this PR of course. There's lots of ongoing core changes and it's not clear to me where the 1.0 release ends and the regular updates begin TBH it's causing some confusion e.g. treeverse/dvc#4011 (comment)

@shcheklein
Copy link
Copy Markdown
Contributor

shcheklein commented Jun 12, 2020

I ran -h at the time of making this PR of course.

I know. I mean that we can run -h for all commands again as part of the DVC 1.0 migration. That's what that epic for. It's not a goal to solve all of these discrepancies at once or even before the release - we need to focus on major things.

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Jun 12, 2020

Got it. Good idea, added a checkbox to the epic and created treeverse/dvc/issues/4024. For now this specific matter (add -f -> --file) is extracted to #1426

@jorgeorpinel jorgeorpinel deleted the 1.0/add branch June 23, 2020 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@shcheklein shcheklein shcheklein approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jorgeorpinel @shcheklein @efiop @dmpetrov