feat: Add codespaces configuration #13
Conversation
Users basically just go to the repository and click a button and they will have their full VSCode IDE environment and then there they will learn about code development. This way, they're familiar with environment outside of a Jupyter interface. 😄 |
Very cool! Does this require to have anything activated at the GitHub organization level? |
Agree this is important - did you know that CryoCloud also has a VSCode IDE? GitHub Codespaces is super neat - I used it for several tutorials at SciPy (@scottyhq set it up for the Xarray one!). Can you share how you're envisioning leveraging Codespaces and CryoCloud simultaneously? |
Actually @lsetiawan set it up originally 😅.
This was new to me! Looks like it isn't documented (https://book.cryointhecloud.com/). But sure enough it's in the launcher: 
|
| // For format details, see https://aka.ms/devcontainer.json. For config options, see the | ||
| { | ||
| "name": "Notebooks to Packages", | ||
| "image": "ghcr.io/uw-ssec/minimal:latest", |
There was a problem hiding this comment.
What's in this image? Can we instead just point to the current CryoCloud image? (Or what packages are not in there that you'd need for this tutorial) https://github.com/CryoInTheCloud/hub-image
There was a problem hiding this comment.
This image is lean and has pixi installed. This tutorial doesn't really need anything fancy :)
@jomey This doesn't require any special permissions, just that they have a Github account |
@JessicaS11 My thought is that I want participant to have a chance to work outside of the CryoCloud since it's more of a "temporary" environment. Using codespaces, it allows them to work in VSCode so they get a nice feel there AND the codespace devcontainer environment can be spun up locally as well. Essentially, I'm trying to introduce a more "local" way of working with code outside of just a "Jupyter" ecosystem since the whole point of this tutorial is really getting out of the Jupyter ecosystem to a full blown IDE. |
Hmmm... I think codespaces is great and am not against using it, but my primary concern with introducing it is that it adds another tool/navigational space to the "firehose" participants get during the week, especially if VSCode (i.e. using an IDE outside of Jupyter) is actually the goal. Ideally, everyone will already have their projects going in CryoCloud, so moving the project to a codespace has the potential to be a barrier that gets in the way of the packaging step (especially if you're newer to git/GitHub). Curious to hear from @jomey and @scottyhq too if I'm making too big a deal about the potential additional tooling load for participants. |
|
After chatting with @scottyhq in person, I'll just stick with cryocloud. I'm just not used to a jupyterhub being available for a long time 😬 Apologies for my old school ness haha 😅 I also agree with your thinking @JessicaS11 Thanks for that thought. |
|
I wouldn't quite call this 'old-school' @lsetiawan and rather qualify this as 'next-level' 😄 Agree, though, that keeping it simple for the hackweek is the path to go. We can always point curious minds towards the IDE path, once they feel ready for it |
Very fair!
Well said! I think that's one of the biggest successes of CryoCloud so far. |
This PR adds a github codespaces configuration for the notebooks to packages tutorial