aiida-tutorials icon indicating copy to clipboard operation
aiida-tutorials copied to clipboard

👌 IMPROVE: Move tutorials to seperate git branches

Open chrisjsewell opened this issue 4 years ago • 3 comments

At present each tutorial is in a folder on the same branch, with new tutorials made by copying across content from the other folders and updating. As the number of tutorials grows though this becomes more difficult to maintain, e.g. having to run through the tests/build for all tutorials when making a new one. Essentially once a tutorial is finished its content is "frozen" so IMO it would be better for these to be encapsulated in their own branches. Then when making a new tutorial, you would simply just clone the relevant past tutorial's branch and update it as necessary. In this way it is also a lot easier to git compare the changes from one tutorial to the next.

chrisjsewell avatar Jul 08 '20 20:07 chrisjsewell

Note we would want for the front page of the latest tutorial to contain links to the past tutorials, but I think this shouldn't be an issue linking to different branches built on RTD (I do this, for example, to showcase different themes in https://sphinx-panels.readthedocs.io/en/alabaster-theme/)

chrisjsewell avatar Jul 08 '20 20:07 chrisjsewell

Sounds like a good idea to me. Probably best start this in a separate fork of the repo so that one can get an idea of how it would look like.

ltalirz avatar Jul 08 '20 20:07 ltalirz

Looking forward to closing this one. 😁

mbercx avatar Jun 09 '21 11:06 mbercx