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.

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

cmd ref: describe update available output (for import stages) in status #477 #1299

Merged
merged 6 commits into from
May 18, 2020

Conversation

imhardikj
Copy link
Contributor

This PR updates \static\docs\commands-reference\status.md with update available output for import stages to fix #477.

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Great start!

In addition to improving the description you added (see the one commend in this review, below), can you also please update one of the examples or add a new one that shows this "update available" case?

The best strategy for both things, so you're 100% sure you understand and thus explain what's happening, is to actually create a couple DVC repos (A and B) locally, dvc add some dummy data in A, use dvc import to bring it to B, update the data in A, and run dvc status in B. This way you will see exactly how DVC behaves under this situation and you'll be able to copy-paste the command output for the examples.

Please ping me on discord if you need more details on setting that up.

We do this kind of micro QA all the time when writing docs, which also helps you become a DVC expert little by little 🙂

content/docs/command-reference/status.md Outdated Show resolved Hide resolved
@imhardikj
Copy link
Contributor Author

@jorgeorpinel thank you for your review. I have updated the explanation with more details. Also made an attempt to include an example.

@shcheklein
Copy link
Member

@imhardikj thanks 🙏

Copy link
Contributor

@jorgeorpinel jorgeorpinel left a comment

Choose a reason for hiding this comment

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

Yep, this is great. I just have some minor comments and suggestions for you. We can merge this after addressing those. Thanks @imhardikj!

content/docs/command-reference/status.md Outdated Show resolved Hide resolved
content/docs/command-reference/status.md Outdated Show resolved Hide resolved
content/docs/command-reference/status.md Outdated Show resolved Hide resolved
content/docs/command-reference/status.md Outdated Show resolved Hide resolved
content/docs/command-reference/status.md Outdated Show resolved Hide resolved
@jorgeorpinel
Copy link
Contributor

Thanks again @imhardikj

@jorgeorpinel jorgeorpinel merged commit 7fec065 into iterative:master May 18, 2020
@imhardikj imhardikj deleted the dvc-status branch May 19, 2020 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cmd ref: describe update available output (for import stages) in status
4 participants