search

pangeo-data / foss4g-2022

Pangeo tutorial at FOSS4G 2022
https://pangeo-data.github.io/foss4g-2022
Other
2 stars 9 forks source link

Where should the Notebooks go? #22

Closed guillaumeeb closed 2 years ago

guillaumeeb commented 2 years ago

Currently, there are two main folders: NOTEBOOKS (not fond of the upper case style), and tutorial. In tutorial: notebooks.

I'm under the impression that all notebooks that workshop participants want to see should be in tutorial/notebooks.

If so, we should move important content from NOTEBOOKS folder to tutorial/notebooks, and either remove the NOTEBOOKS folder, or rename it in a way it is clear that its content is not important for learning about Pangeo.

Anyway, I think we should clarify things here.

acocac commented 2 years ago

@guillaumeeb the NOTEBOOK folder is temporal. We can rename and keep it as a miscelaneous folder with unfinished notebooks.

pl-marasco commented 2 years ago

I fully support the idea of @guillaumeeb start cleaning up a little bit. I would also suggest taking a decision regarding the monolithic notebook. from my perspective here are the options:

I would vote for the second one but at the same time maybe would be better to focus on something that is more useful for the participants.

@guillaumeeb @acocac @tinaok @annefou how about these options?

edit: typos

annefou commented 2 years ago

The notebooks are not meant to be used for the workshop. We used them to derive the training material. They could showcase complete use cases using best practices and could be re-used by attendees for their own use cases. The initial idea was to create FAIR Digital Object for each of these notebooks that can be easily found for instance in EOSC Explore. This is also to give more visibility to the authors of these notebooks as individual contribution.

guillaumeeb commented 2 years ago

I would at least rename the folder to something that says clearly this is not the principal content, as @acocac proposed.

Maybe dev-material, or misc, I've trouble finding the correct term.

annefou commented 2 years ago

what about example or showcase osr use-case?

pl-marasco commented 2 years ago

Whatever the name will be, can we move the folder from ./NOTEBOOK to ./tutorial/notebooks?

Exercise declined in the meaning of an activity carried out for a specific purpose could be another option.

annefou commented 2 years ago

Following your suggestion, I created a PR #44