nceas-learning-hub / coreRlessons

What the Package Does (Title Case)
Other
0 stars 0 forks source link

Lessons naming convention #1

Open camilavargasp opened 1 month ago

camilavargasp commented 1 month ago

As for now, I'm trying to name the few lessons we are using to test the new workflow in a logical way that is easily adaptable to other lessons. Some general rules:

camilavargasp commented 1 month ago

Note: I added the images for each lesson in the inst/images folder. However, I did not edit names of these files.

oharac commented 1 month ago

I think that should be fine - it is keying off of the folder name, tied to the lesson name, so all the files inside the folder will come along for the ride

oharac commented 1 month ago

Because a data folder in inst potentially conflicts with accessing a data folder elsewhere in the package, I renamed that folder to lesson_data, and to keep the structure similar I renamed the image folder to lesson_img. Everything else should be fine. For ease of code so far, these get copied over into the newly created course directory with the same names, into the materials folder, so materials/lesson_data and materials/lesson_img - while the lessons themselves are stored as .qmds in materials/lessons.

Additionally, I added a license (MIT for now).