search

ProjectPythia / cookbook-template

Project Pythia Cookbook template
https://projectpythia.org/cookbook-template/
Apache License 2.0
21 stars 16 forks source link

Incorrect instructions for launching Binder for cookbooks #105

Closed maxrjones closed 1 year ago

maxrjones commented 1 year ago

When reviewing the new Kerchunk cookbook, I noticed that the instructions for running on Binder are the same for foundations chapters and cookbooks, but the methods for launching are different (see below).

Foundations Cookbook
image image

Also, the section includes a relative path to an image that only exists in the pythia-foundations repository.

Foundations instructions: https://foundations.projectpythia.org/preamble/how-to-use.html#interacting-with-jupyter-notebooks-in-the-cloud-via-binder Example cookbook instructions (based on template): https://projectpythia.org/kerchunk-cookbook/README.html#running-on-binder

brian-rose commented 1 year ago

Hi @maxrjones, I'm not sure I understand the issue properly. Agreed that we should fix the reference to a non-existent image in the Cookbook template.

But as far as launching the Binder, in all cases (Foundations or any Cookbook) when you're looking at a page that was rendered from a .ipynb file, you'll see the "Rocket Ship" launch icon at top right. I think that's what those intstructions are trying to point out.

e.g. in the rendered template on this page, or in the Kerchunk cookbook on this page

In both cases (Foundations and Cookbook) it's also possible to launch the Binder from links on the README page, and maybe that's a source of confusion.

maxrjones commented 1 year ago

Hi @maxrjones, I'm not sure I understand the issue properly. Agreed that we should fix the reference to a non-existent image in the Cookbook template.

But as far as launching the Binder, in all cases (Foundations or any Cookbook) when you're looking at a page that was rendered from a .ipynb file, you'll see the "Rocket Ship" launch icon at top right. I think that's what those intstructions are trying to point out.

e.g. in the rendered template on this page, or in the Kerchunk cookbook on this page

In both cases (Foundations and Cookbook) it's also possible to launch the Binder from links on the README page, and maybe that's a source of confusion.

Thanks for your quick and helpful response! In re-reading the instructions, I think it's clear that the instructions are for launching Binder from the individual chapters rather than the README so I'll close this issue.