search

scipy-2023-image-analysis / tutorial

BSD 3-Clause "New" or "Revised" License
6 stars 8 forks source link

Rebrand and prepare documentation notebooks #5

Closed lagru closed 1 year ago

lagru commented 1 year ago

I find the tutorial documentation so confusing? In part it's aimed at me preparing the tutorial, in part at participants, and in part referring to outdated things (.ipynb), downloading notebooks, etc. :sweat_smile:

jni commented 1 year ago

I find the tutorial documentation so confusing? In part it's aimed at me preparing the tutorial, in part at participants, and in part referring to outdated things (.ipynb), downloading notebooks, etc. 😅

@lagru sorry about that, we probably should have given you more context about the source here, which is a workshop template so that people making workshops have all of the infra (jupyter book, gh-actions) set up already. But yeah, all of the instructions for instructors should be gone before we launch, and only the notebooks that we intend to use should remain. (I would remove the old ones rather than just remove them from the TOC.)

At any rate the book building on actions is broken right now... 😭 so we might not be getting all that much value out of the template. 😭

Immediately after this merge @lagru we should use jupytext to convert the relevant notebooks from the skimage tutorial to md and then commit those. But I think it's a good idea to do that in a follow-up PR.

lagru commented 1 year ago

At any rate the book building on actions is broken right now...

Oh? So we shouldn't try to fix our CI for this repo? Is there no way to circumvent that by replacing the action with manual instructions?

lagru commented 1 year ago

Ready from my side. @jni, if you want to do the honor? Otherwise I'll merge in a few hours from now.

lagru commented 1 year ago

Re https://github.com/scipy-2023-image-analysis/tutorial/pull/5#issuecomment-1617575032, at the worst we can maybe push our local build to the pages manually?

jni commented 1 year ago

Re https://github.com/scipy-2023-image-analysis/tutorial/pull/5#issuecomment-1617575032, at the worst we can maybe push our local build to the pages manually?

Sure! But I don't consider it a priority. The book/site is very valuable if you have a jupyter-lite built and they can run it online or whatever. But for an interactive tutorial, the most important thing is that they can download the repo and run some cool notebooks interactively with the class, and do the exercises. A fancy online website as an artifact at the end is cool but "icing on the cake," so to speak. First we should bake a cake! 😂