Skip to content

cmd ref: use example-get-started repo in pull examples #528

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

Closed
shcheklein opened this issue Aug 7, 2019 · 11 comments · Fixed by #1340 or #1365
Closed

cmd ref: use example-get-started repo in pull examples #528

shcheklein opened this issue Aug 7, 2019 · 11 comments · Fixed by #1340 or #1365
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference good first issue Good for newcomers type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@shcheklein
Copy link
Member

shcheklein commented Aug 7, 2019

To make examples less abstract. Make them more actionable.

See how they're used in https://dvc.org/doc/command-reference/checkout#examples

@shcheklein shcheklein added type: enhancement Something is not clear, small updates, improvement suggestions A: docs Area: user documentation (gatsby-theme-iterative) command-reference good first issue Good for newcomers labels Aug 7, 2019
@dashohoxha
Copy link
Contributor

It seems to me that the example of checkout is a good one for pull as well.
It can even be referenced from the pull page with a link like this: https://dvc.org/doc/commands-reference/checkout#examples

I would even go a step further and say: why not factor out interactive examples from the command pages, and then link to the relevant examples from these pages? An interactive example may be linked from more than one command page, and a command page may refer to more than one example.

(Maybe I should have started a new issue for discussing this idea, I am not sure.)

@shcheklein
Copy link
Member Author

Great question. I think they can be very similar but should emphasize different parts. Also, pull can be way simpler. And dvc checkout can be simplified by making fetch -aT as a preparation step (to warm up the cache).

@jorgeorpinel jorgeorpinel changed the title pull: use example-get-started repo in Examples section cmd ref: use example-get-started repo in pull examples Jan 19, 2020
@imhardikj
Copy link
Contributor

imhardikj commented May 20, 2020

@shcheklein @jorgeorpinel I can work on this issue. As the title suggests should I add a pull example which uses example-get-started repo.
Something like this: https://dvc.org/doc/tutorials/get-started/retrieve-data

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented May 21, 2020

And dvc checkout can be simplified by making fetch -aT as a preparation step (to warm up the cache).

@imhardikj maybe you can start by doing that and open a PR? It will help you understand wha this issue is about. After that, you can also close this issue in the same PR:

should I add a pull example which uses example-get-started repo. Something like this: https://dvc.org/doc/tutorials/get-started/retrieve-data

It's good that you checked out that page Hardik, but please ignore it for this issue (it will be changing a lot soon). The main idea here is to come up with a way to use the example-get-started repo for https://dvc.org/doc/command-reference/pull#examples (similar to cmd-ref/checkout#examples).

@sarthakforwet

This comment has been minimized.

@imhardikj
Copy link
Contributor

imhardikj commented May 22, 2020

And dvc checkout can be simplified by making fetch -aT as a preparation step (to warm up the cache).

@jorgeorpinel After cloning example-get-started repo when I attempt to run dvc fetch -aT it gives an unexpected error. It worked before when I was on version 0.92.0. I tried running this on windows too but it gives same error. I couldn't find anything related to this error and raised the issue as I thought it was a bug. I found a similar issue for dvc pull.

In checkout example if we don't use fetch -aT in "Click and expand to setup the project" then dvc fetch needs to be used again after git checkout.
How should I proceed next w.r.t. checkout example?

@shcheklein
Copy link
Member Author

shcheklein commented May 22, 2020

After cloning example-get-started repo when I attempt to run dvc fetch -aT it gives an unexpected error

@imhardikj this is known p0 problem in the recent DVC version. We are fixing it already, sorry about this inconvenience.

Could you please rely on 0.92 for now?

@jorgeorpinel

This comment has been minimized.

@jorgeorpinel
Copy link
Contributor

And dvc checkout can be simplified by making fetch -aT as a preparation step (to warm up the cache)...

In checkout example if we don't use fetch -aT in "Click and expand to setup the project" then dvc fetch needs to be used again after git checkout.

@imhardikj fetch -aT is not currently used in the expandable section. The suggestion is to add it there so it can be removed from the block further down. There's an explanation about it under that block too, which would probably need to go away (moved into the expandable section too).

However the fetch + checkout parenthesis would have to go away too (not moved, just gone). Instead maybe we can just link "fetch" and "checkout" in We can now just run dvc pull that will fetch and checkout the most recent further above? Just a thought.

@imhardikj
Copy link
Contributor

@shcheklein @jorgeorpinel This issue got closed because #1340 was merged. But dvc pull hasn't been updated yet. I have updated the title and description of #1340.
I will open a new PR to work on dvc pull meanwhile can you open this issue again.

@shcheklein
Copy link
Member Author

@imhardikj sure thing! thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) C: ref Content of /doc/*-reference good first issue Good for newcomers type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
6 participants