carpentries / styles

Styles for The Carpentries lessons. No README to avoid merge conflicts with lessons. Demo 👇
https://carpentries.github.io/lesson-example
Other
85 stars 96 forks source link

put figshare links for data in the _config.yml file #337

Open fmichonneau opened 6 years ago

fmichonneau commented 6 years ago

to make it easier to update data files, https://github.com/datacarpentry/OpenRefine-ecology-lesson/pull/151 suggested we put the download links in the _config.yml file. This idea could we considered in the future.

brownsarahm commented 6 years ago

I like this idea overall, but we would have to consider how it works for multiple data files, for example messy and clean versions or the multiple files many python lessons have for teaching how to do pandas merges.

Maybe a solution using jekyll's data functionality is better than in the config file?

The folder could either have one .yml file per data file in it, where for each data file there is information like the excerpt below. This could also be used to generate a data reference page (I think there is one something like this on the curriculum overview pages for data carpentry lessons, but it's easy to forget to use that).

_data/example-data.yml:

csv_download : http://figshare.com/the/file/needed
data_name : Exemplary Dataset
data_description : a data set that is collected from a place and formatted...

Then this would be accessed in the markdown as {{ site.data.example-data.csv_download }} etc. where example-data would change per data file.