LearnToDiscover / sandpaper

L2D's fork of {sandpaper}
https://learntodiscover.github.io/sandpaper/
Other
0 stars 1 forks source link

Create L2D handbook #73

Closed L2D-admin closed 5 months ago

L2D-admin commented 6 months ago

Under the 'learner profiles' we can add, for instance, a single set of instructions for students on how to do a single thing. For example, using terminal for x, y or z. Is it possible to have multiple 'files' or sets of instructions here? So if we wanted to add a second set of instructions on how to set up a Codespace, for example: is this an option? Thank you!

milanmlft commented 6 months ago

Yes, this is possible, see for example https://github.com/carpentries/sandpaper-docs/tree/main/learners For which the rendered website looks like this:

Screenshot 2024-05-30 at 15 36 51

See also the sandpaper documentation

sabaferdous12 commented 5 months ago

Hi Milan @milanmlft ,

I have tried doing this (multiple md files) but looks like we can't see it as we have removed More button.

I was wondering if we could have that back and rename it as Handbook?

milanmlft commented 5 months ago

To do

~Alternative~

~In caser the above doesn't work:~

~- [ ] Re-add More button; partially revert https://github.com/LearnToDiscover/varnish/pull/20~ ~- [ ] Rename More to L2D Handbook~

milanmlft commented 5 months ago

L2D Handbook lesson

Regarding the last point, I have stripped down the files as much as possible to the minimal required contents. For learners/setup.md, I have replaced the contents with an overview of the handbook's sections (currently just placeholder files), as this is the file shat is shown on the homepage by default.

Of course, feel free to edit any of these files as you wish!