iterative / example-repos-dev

Source code and generator scripts for example DVC projects
https://dvc.org/doc
21 stars 13 forks source link

Add GTO get started #110

Closed aguschin closed 2 years ago

aguschin commented 2 years ago

Ok, I created PR to example-repos-dev, but in the process I think we losed the great way for users to regenerate the repo themselves (this is mode important compared to DVC or MLEM). Earlier it was like this: fork, clone, checkout to dev, run bash script. Now you can also do that, but you need to clone example-repos-dev, which is another repo, and then monkeypatch generate.sh, then deal with gh and etc. It's acceptable for us, but not so easy for users. I will consider creating self-contained example repo which could be used in old scenarios.

shcheklein commented 2 years ago

but you need to clone example-repos-dev, which is another repo

this repo is not meant to be used by users / readers. This repo is done for us to help us maintain tutorials / example repos. E.g. if I want to change something in the middle of the example repo history, update tools, updates all .dvc files in the history to the newer version, etc - this repo help a lot with this.

In case of GTO this repo could be used to generate the self-contained example repo and then text tutorial can show users what do with it. Essentially this repo is for us to help us maintain and keep up to date the self-contained example repo in this case.

Or it can be that you decide to all the steps for users and make it the final result - that's also fine, our docs are written in way that users can take the final repo result if they want, but they could also go thought the process from the very beginning (git init, dvc init, add code, etc) or from a tag in the middle (and we provide the list of tags).

shcheklein commented 2 years ago

@aguschin is it still relevant?

aguschin commented 2 years ago

@shcheklein, yes. I'll address this after MLEM release.

shcheklein commented 2 years ago

@aguschin closing this? is it still relevant?

aguschin commented 2 years ago

@shcheklein, yes, it is. This generates https://github.com/iterative/example-gto

shcheklein commented 2 years ago

@aguschin let's finalize and merge it properly then please?

aguschin commented 2 years ago

@shcheklein, please see the new GH actions example. It doesn't do real publish/deploy, but it should look more confident now.

https://github.com/iterative/example-gto/actions

image
shcheklein commented 2 years ago

@aguschin looks good, thanks! (I approved the PR btw yesterday :) )