search

carpentries / styles

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

Link to Setup files in each Episode #434

Open fmichonneau opened 5 years ago

fmichonneau commented 5 years ago

Initially reported in swcarpentry/r-novice-inflammation#448

Dear Software Carpentry Community,

My name is Michael Anderson and I am posting this issue as part of the Instructor Checkout process.

While I have was reviewing the different lessons/episodes in preparation for the demonstration portion of the Checkout process, it took me a while to realize the required files were on the Schedule page for each lesson, via the Setup link. While following a lesson for the first time, it would have been convenient for me to have the Setup link (of data files) at the top of each Episode page. Would this be more trouble than it is worth to accomplish?

I am not sure if this would also help others but it would have helped me in the beginning so I thought it may be worth suggesting for new users.

Thanks in advance. I look forwarding to being a part of this community.

-Michael Anderson

brownsarahm commented 5 years ago

Setup is on the menu, so it is already at the top of every episode page.

Maybe we should add it in a prerequisite (or maybe a new type of call out) box on the lesson homepages instead of in the schedule table? We could add that box to the lesson layout so that individual lesson maintainers don't have to add it and it's always there.

maxim-belkin commented 4 years ago

As Sarah mentioned, our navigation bar has a dedicated link to the lesson's setup page visible at all times. Adding yet another link to the beginning of every episode seems unnecessary because they will appear not so far from the link that we currently have.

As for the content of the homepages: most of the lessons I checked have "Prerequisites" boxes with links to their setup pages already (I found one exception but that lesson does not have any required material/software beyond what is required by a standard SWC workshop). So, I vote to pass on this suggestion without making any changes to the template.

bencomp commented 2 years ago

I agree to close this issue.