search

2i2c-org / docs

Documentation for 2i2c community JupyterHubs.
https://docs.2i2c.org
9 stars 17 forks source link

Write technical content for guiding communities on how to build custom images for their hubs. #210

Closed jnywong closed 3 months ago

yuvipanda commented 4 months ago

I gave a talk about this exact topic at JupyterCon last year. https://www.youtube.com/watch?v=qgLPpULvBbQ

Slides at https://docs.google.com/presentation/d/16V6ylmirxxBTlVq-tZ9dsFYCf1Abbl83Rv350Rc-DL4/edit#slide=id.p

I would consider the talk / slides as current best practice, which unfortunately is not reflected in the documentation we already have.

jnywong commented 3 months ago

Thank you @yuvipanda for sharing your talk, I think many communities will benefit from this being documented in our Service Guide docs.

jnywong commented 3 months ago

As a starting point I am going to document "Use upstream maintained image + packages" first, since this seems to be the most pertinent use case identified.

jnywong commented 3 months ago

Coming up against a GH action failure when replicating the example in https://github.com/yuvipanda/example-inherit-from-community-image. Build logs indicate a problem with accessing repo contents:

ls: cannot access 'image-tests/*.ipynb': No such file or directory ERROR: file or directory not found: image-tests/

yuvipanda commented 3 months ago

@jnywong ah, this is great. I would say that the immediate way for you to unblock yourself is to remove the image-tests directory in the repo - I think it's a nice to have but not fundamentally essential. The image-tests feature was added in https://github.com/jupyterhub/repo2docker-action/pull/83, and probably there's some bug here in how that's working.

So my suggested action items here are:

In general this is also a good workflow for unblocking ourselves i think:

  1. Do the minimum necessary to immediately unblock ourselves
  2. But always report the issue upstream where it needs to be. Figuring out where this needs to be can be difficult, and is something I am happy to help with!
  3. Once it's fixed upstream somehow, we can incorporate it back into our work here.

I think this allows us to keep moving while also overall improving the quality of the Jupyter ecosystem!

jnywong commented 3 months ago

Thanks for this @yuvipanda ! Wise words that I will be taking forward with me in general 👍

yuvipanda commented 3 months ago

@jnywong glad to be of help!