esciencecenter-digital-skills / research-software-support

Content for the Research Software Support platform
https://esciencecenter-digital-skills.github.io/research-software-support/
Other
0 stars 3 forks source link

Add numerical values to chapter filenames to sort them inside each module #47

Closed Cmurilochem closed 1 month ago

Cmurilochem commented 2 months ago

A new convension has been settled that the order of the chapters inside each module should be determined be numerical values at the start of each filename. For example, inside the module modules/publication, files which were hitherto organized as:

├── discussion.md
├── slides-publication.pmd
├── software_publication_pipeline.md
├── automating_software_publication.md
├── ex_registries.md
├── reading.md
└── media
    ├── nlesc-dummy.png
    └── repository_logos.png

should now be named:

├── 01.discussion.md
├── 02.slides-publication.pmd
├── 03.software_publication_pipeline.md
├── 04.automating_software_publication.md
├── 05.ex_registries.md
├── 06.reading.md
└── media
    ├── nlesc-dummy.png
    └── repository_logos.png

The numerical values at the start of the filenames will determine their order of appearance within each module. We should then perform the proper adaptations to other modules accordingly.

LourensVeen commented 2 months ago

Are the slides supposed to be part of this sequence, or should they be considered a separate thing?

Cmurilochem commented 2 months ago

Are the slides supposed to be part of this sequence, or should they be considered a separate thing?

Good question! I was asking right now this to myself, given their special extension. But I suppose so, since their order is also undetermined. @JaroCamphuijsen or @raar1, could you clarify this ?

LourensVeen commented 2 months ago

I think I saw an issue somewhere about learning goals and learning methods, and I'd say the slides are for classroom teaching, while the text is for self study. So maybe it makes sense to treat those separately. On the other hand, the exercises will be in both.

JaroCamphuijsen commented 2 months ago

Yeah the slides document should be part of this sequence. so just 03.presentation.pmd for example

JaroCamphuijsen commented 1 month ago

This issue is not valid anymore. The specs from NEBULA have changed in https://github.com/esciencecenter-digital-skills/NEBULA/pull/36 and chapter order is now defined in the headers of the md files using the order keyword.