2i2c-org / demo-gallery

Gallery website to demonstrate community success stories
http://2i2c.org/demo-gallery/
MIT License
0 stars 0 forks source link

Decide if each demo needs to live in its own github repo #7

Closed jmunroe closed 1 day ago

jmunroe commented 1 day ago

Task: Make a decision from one of the following options or propose a new option for how to organize these demos

Option 1: All AGU demo content will be part of the same github demo-gallery repo.

This keeps all of the content around the AGU demos together as a coherent whole and will make it easier to cross-link from the gallery page to individual demos as pages. Theming and styling are automatically consistent.

Different demos will require different environments. We know how to have multiple image specifications in one repo (see 2i2c's Community Showcase). But, I am not aware of how to do this with dynamic image building. We also want to demonstrate how a magic link (nbgitpuller) takes the reader to a full environment. I am not sure how to do this with multiple environments within the same repo.

Option 2: Each demo is created as a stand-alone repo.

Easier to ensure each demo runs independently. It is clear how to define one environment per repo. Each demo would itself be a stand-alone myst site.

This is the model that we used for Project Pythia. We found a way to link a common theme file into each project to keep them consistent.

If we use the 2i2c-org that means the creation of many new repos which is cluttered.

Option 3: Host all demo content in a new github org.

The gallery and each demo would all reside in the same to be created github organization. This would keep them logically together and not pollute our main 2i2c-org with one-off repos. Each demo would reside in its own github repo.

This was the strategy we used to prototype the Project Pythia cookbooks and I think it worked well.

jmunroe commented 1 day ago

My recommendation is 'Option 3' but I'd like input from @yuvipanda and perhaps @agoose77 to validate that recommendation.

agoose77 commented 1 day ago

@jmunroe I think (2) is probably best -- we already have "too many repos", and it will simplify permissions etc. for other contributors from 2i2c.

jmunroe commented 1 day ago

Thanks @agoose77 . That makes sense ... I'll create a new repo for each demo.