search

iterative / example-repos-dev

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

feat(example-get-started): config to generate nested repos #214

Closed shcheklein closed 1 year ago

shcheklein commented 1 year ago

Addresses partially https://github.com/iterative/studio/issues/6559 .

Add a way to generate repos similar to these ones:

Screenshot 2023-07-03 at 8 52 16 PM
shcheklein commented 1 year ago

Can we add some instructions in the README?

Yep. I plan to add the instruction in the repo itself that is being generated (and already did some steps in that direction - it dumps its own config) + comments in the script. WDYT?

Are we expected to force-push those repos in the screenshot whenever the "main" example-get-started is regenerated?

Yes, it's will be a force push or we can recreate them. We'll see. Not sure yet. Need to get more data on the usage first tbh.

shcheklein commented 1 year ago

I've updated it one more time. One item left - to move the instructions into README.

At the end it generates this kind of repos https://github.com/iterative/monorepo-fixture

@daavoo @amritghimire @aguschin I suggest the we rename all the repos into -fixture . I don't like test since it is sometimes someone actually testing it. It should be nonetheless visible that this is a fixed testing repo.

Let's rename all those fixtures please one by one and use the same convention. Also as I mentioned somewhere, make sure that we can generate any of them anytime.

amritghimire commented 1 year ago

I've updated it one more time. One item left - to move the instructions into README.

At the end it generates this kind of repos https://github.com/iterative/monorepo-fixture

@daavoo @amritghimire @aguschin I suggest the we rename all the repos into -fixture . I don't like test since it is sometimes someone actually testing it. It should be nonetheless visible that this is a fixed testing repo.

Let's rename all those fixtures please one by one and use the same convention. Also as I mentioned somewhere, make sure that we can generate any of them anytime.

I am okay with it. I think @omesser started adding some labels to increase visibility in readme files as well to distinguish the repo. If possible, let's archive the repo once the migrations are over.

shcheklein commented 1 year ago

Merging this, but we can keep the discussion and improving docs / READMEs on the fixtures gen.