Skip to content

imports: examples for new import, update cmd refs; et al [WIP]#509

Merged
shcheklein merged 28 commits into
treeverse:masterfrom
jorgeorpinel:master
Aug 5, 2019
Merged

imports: examples for new import, update cmd refs; et al [WIP]#509
shcheklein merged 28 commits into
treeverse:masterfrom
jorgeorpinel:master

Conversation

@jorgeorpinel
Copy link
Copy Markdown
Contributor

@jorgeorpinel jorgeorpinel commented Jul 30, 2019

Fix #487

@jorgeorpinel jorgeorpinel mentioned this pull request Jul 30, 2019
Merged
@jorgeorpinel jorgeorpinel changed the title imports: examples for new import, get, update cmd refs imports: examples for new import, get, update cmd refs; et al Jul 30, 2019
shcheklein
shcheklein reviewed Jul 30, 2019
View reviewed changes
Comment thread static/docs/commands-reference/add.md
shcheklein
shcheklein reviewed Jul 30, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md
shcheklein
shcheklein reviewed Jul 30, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
shcheklein
shcheklein reviewed Jul 30, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md
shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
shcheklein
shcheklein suggested changes Jul 31, 2019
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.

put a few comments. Is it still WIP?

shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/user-guide/external-dependencies.md Outdated
@jorgeorpinel jorgeorpinel changed the title imports: examples for new import, get, update cmd refs; et al imports: examples for new import, update cmd refs; et al [WIP] Jul 31, 2019
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Jul 31, 2019 •
edited
Loading

Is it still WIP?

Yes, I haven't included the examples for import and update yet.

shcheklein
shcheklein reviewed Jul 31, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import-url.md Outdated
@jorgeorpinel

This comment has been minimized.

Sign in to view
shcheklein
shcheklein reviewed Aug 1, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import.md Outdated
@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Aug 1, 2019

07b4250 adds a super simple example for the dvc update cmd ref. Not sure it's needed as I plan to make another one right after with an actually changed data artifact...

@shcheklein
Copy link
Copy Markdown
Contributor

shcheklein commented Aug 1, 2019

@jorgeorpinel it looks a bit strange, but let's keep it. better than nothing. Let me know when I can merge this. Then we can think about more advanced examples, get started, use cases.

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Aug 1, 2019

Everything has basic examples now @shcheklein. I think we're ready for the advanced ones and related Get Started and User Guide updates. I'll message you on Discord about the plan for that.

I was planning to use this same PR for the advanced stuff too but feel free to merge it now if you prefer 🙂

shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/commands-reference/import.md
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/commands-reference/update.md Outdated
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/get-started/example-pipeline.md Outdated
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/user-guide/contributing.md Outdated
shcheklein
shcheklein suggested changes Aug 2, 2019
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.

minor comments, and please check the example-pipeine carefully - it looks like it might be broken now

@jorgeorpinel
Copy link
Copy Markdown
Contributor Author

jorgeorpinel commented Aug 2, 2019 •
edited
Loading

re check the example-pipeine carefully:

Moved to #487 (comment)

@shcheklein shcheklein temporarily deployed to dvc-org-pr-509 August 2, 2019 05:29 Inactive
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/commands-reference/update.md Outdated
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread static/docs/commands-reference/update.md
shcheklein
shcheklein reviewed Aug 2, 2019
View reviewed changes
Comment thread src/Documentation/glossary.js Outdated
@jorgeorpinel
status: small bullet list fixes
7955ebf 
per #416 (review)
and #416 (review)
@jorgeorpinel
cmd ref: remove a few unnecessary tabs
7b2ed8d
@jorgeorpinel
import: review external-dependencies guide examples and add one for i…
9de26d4 
…mport

For issue #487
@jorgeorpinel
user-guide: remote unnecessary bullet lists in contributing docs
10dd44f 
per #491 (comment)
@jorgeorpinel
term: python -> Python
96bf032
@jorgeorpinel
term: fix typos in dvcignore guide and "lets" -> "let's" throughout docs
df059b9 
per #494 (review)
and #494 (review)
@jorgeorpinel
cmd ref: min text improvements
6dccbdf 
per #494 (review)
@jorgeorpinel
cmd ref: restore a couple git add ines in fenced code block samples
5b09907 
per #509 (review)
@jorgeorpinel
import-url: first feedback round in PR #509
f814d26 
starting at #509 (review)
@jorgeorpinel
user-guide: improve expandable header in external-dependencies doc
52232fb 
per #509 (review)
@jorgeorpinel
cmd ref: 2nd feedback round in PR #509
74abfe8 
see #509 (comment)
and #509 (review)
@jorgeorpinel
import: add basic example, and related updates in other docs
863c5db 
for #509
@jorgeorpinel
term: "data set" -> "data sets"; remove accidental example in update …
ad6c28d 
…ref; and!

and remove/unindent unnecessary bullet lists in example-pipeline chapter of Get Started.
@jorgeorpinel
update: add first, simple example
0ba7e6a 
for #509
@jorgeorpinel
imoprt: change basic example to download data instead of model
288a9dc 
per #509 (review)
@jorgeorpinel
user-guide: update dvc-file-format doc to include special dependencies
88be660 
per #509 (review)
@jorgeorpinel
update: clarify text in example
202e805 
per #509 (review)
@jorgeorpinel
get-started: fixed <details> sections in example-pipeline doc
21e09b5 
per #509 (review)
@jorgeorpinel
user-guide: move up note in contributing for readability
7a1d82a 
per #509 (review)
@jorgeorpinel
lock: update update description and related cmd refs.
be6d512 
per #509 (review)
@jorgeorpinel
update: rewrite cmd ref desc with user perspective focus
7035dfb 
per #509 (comment)
@jorgeorpinel
cmd ref: remove info about locked: true field in DVC-file
f3d3447 
per #509 (comment)
@jorgeorpinel
glossary: expand on "External Dependency" term
077064f 
per #509 (review)
@jorgeorpinel
update: change references to import stages being unlockable
79eb30b 
per #509 (review)
@jorgeorpinel
glossary: add "DVC repositories" to external dependency term desc.
fb7ec4f 
per #509 (review)
@jorgeorpinel
lock: remove dvc lock mention and clarify special import stage "loc…
8d91151 
…king"

per #509 (review)
@jorgeorpinel
import-url: remove buggy line from sample console output
ff095ae 
per #509 (review)
shcheklein
shcheklein approved these changes Aug 5, 2019
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.

Great stuff 🎉 :)

@shcheklein shcheklein merged commit 368ba1b into treeverse:master Aug 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@efiop efiop efiop left review comments

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

cmd ref: advanced examples for import (and get)

3 participants

@jorgeorpinel @shcheklein @efiop