search

archivesunleashed / auk-notebooks

Jupyter notebooks to assist in creating additional analysis and visualizations of Archives Unleashed Cloud derivatives.
https://cloud.archivesunleashed.org
Other
11 stars 5 forks source link

Adopt workflow for preserving old notebooks #6

Closed greebie closed 5 years ago

greebie commented 5 years ago

Unlike other repositories, each notebook has its own code and visualisation that may change over time. Once we have an acceptable prototype, I propose that we keep it somewhere for future reference.

Whether this is via release or a separate folder using some versioning markers, I think it's worthwhile to track which notebooks are "final" (as opposed to experimental or draft).

ianmilligan1 commented 5 years ago

I noted this on Slack, but we're using version control on this repo. If we're making major changes to notebooks, removing functionality, let's just make sure it's in the commit message and we can fish it out?

greebie commented 5 years ago

That sounds reasonable. We can use:-

New Final Draft: auk-notebook x.x.x

ianmilligan1 commented 5 years ago

Sure, although we will forget what those versions mean over time. I think if we are worried about this, making sure the commit messages are substantive.

ruebot commented 5 years ago

Why not actually use git, and tag releases? If we're using Docker, then it'll work as well for Docker Hub.

ianmilligan1 commented 5 years ago

OK. I think we have a workflow here.