search

xgcm / xgcm-examples

Examples and tutorials for xgcm
MIT License
12 stars 12 forks source link

Issues with binder env #1

Closed rabernat closed 3 years ago

rabernat commented 3 years ago

I don't think this will work with binderbot because you are not pointing to a proper binder repo here:

https://github.com/xgcm/xgcm-examples/blob/0fbaaf1ec7f4e694accd3de181919238b84ab0b7/binder-gallery.yaml#L7-L8

Can you try using the default binder?

https://github.com/pangeo-gallery/example-gallery/blob/315eb264ebfb94651ee336ea1e7babe48b22fd1c/binder-gallery.yaml#L8-L9

That will also fix your build, because the image is already built.

jbusecke commented 3 years ago

Thanks @rabernat I think I just pasted this on the wrong line. Apologies...

Admittedly I am flying a bit blind here. I think it might be good to show an example of 'what to replace' in the Remove the dummy content and add your content. bullet?

I used some of the existing gallery repos to 'visually diff' the changes necessary, but clearly, I got confused in the process.

rabernat commented 3 years ago

Agree it is currently super confusing. Would love suggestions on how to improve.

jbusecke commented 3 years ago

I just now saw this section. Id suggest a few things: 1) Link to that bottom section in the bullet mentioned above. 2) Somehow mark and indicate which entries need to be changed. I personally like a concrete example (e.g. one of the existing gallery repos). Perhaps you could show the 'diff' output of the template and another repos yaml?

jbusecke commented 3 years ago
  1. This sentence ("Sometimes, the GitHub Action to add your repo as a submodule will fail. We can work with you to identify and fix issues. Sometimes, making a new issue in the same way as above is necessary to correctly reload new settings from your gallery repo.") is great advice, but I think it would be good to show the user what a 'success' looks like beforehand.

E.g. Before the sentence say: "If your request was successful, you will see an automated response like this:" image

jbusecke commented 3 years ago
  1. I think the user then needs some more info about what will happen next and if they need to do anything except for wait for the gallery maintainers to merge?
jbusecke commented 3 years ago

@rabernat Should I paste these suggestions in another issue, so we can close this one?