Create page where teaching materials can be easily accessed in a variety of formats

angela-li commented 5 years ago

As mentioned in forwards/tasks#44, we should make these materials discoverable and easy to update/manipulate, for those who wish to use these lesson materials to teach in their communities.

Perhaps we could do this in the README on this repo - or even include a "Resources" page on our website.

hturner commented 5 years ago

I will create a space on the website where this can be put.

hturner commented 5 years ago

As it may be a while before I can work on the website, you might like to start working on the content in a plain markdown file to start with.

dicook commented 5 years ago

isn't the teaching-examples repo the home for this? I don't see why this is difficult to access.

hturner commented 5 years ago

I think the issue is that our bank of teaching resources is getting harder to navigate: we have various versions of the package workshop materials in the workshops repo and a mix of data sources and teaching materials/examples (possibly with varying licenses) in the teaching-examples. The other issue is discoverability: people only tend to go digging in GitHub repos if they're looking for something specific; having an overview on the website would help people to know what's there. This could be supported by improved READMEs, e.g. yesterday someone was trying to find our material on unit testing- it's not that obvious!

Thinking about it a bit more I think the "Edu" page on the Forwards website should become a front page to the work of the teaching team, with links to more detailed pages. Something like:

Forwards workshops (description, link to new workshops sub-page, which has most of current Edu page content
Forwards teaching materials (description, link to new materials page giving overview of what's available)
Diverse teaching examples (description, could just link to teaching examples rep for now)
Teaching related blog post (automatically added, looks like I currently have it to show most recent two).

This format is easy to extend and quite natural to navigate, e.g. the sub-pages would be like https://forwards.github.io/edu/chicago/, where it's easy to get back to the man edu page. It also means I don't have to adjust the navigation/main pages (for now, it might be nice to have a main page for each team eventually).

hturner commented 5 years ago

I've now created the basic structure, using the existing content. I kept individual workshop pages at the same level as the workshop page (https://forwards.github.io/edu/workshops/), so any old links will still work, e.g. https://forwards.github.io/edu/chicago/. That means relative links from the workshops page should be of the form [Chicago](../chicago).

Possibly in future, we will want to put individual workshops as sub-pages to the workshops page. This can be implemented by creating a workshops folder under the edu one, putting all the workshop pages within that and making workshops.md the _index.md of that folder. Then links would be of the form https://forwards.github.io/edu/workshops/chicago/. Not sure which you prefer, so I did the backwards-compatible option for now.

To get back to this issue, a page giving an overview of teaching materials can now be created in content/edu/teaching_materials.md and linked from the relevant paragraph on content/edu/_index.md.

forwards / workshops

Create page where teaching materials can be easily accessed in a variety of formats #6