bssw-tutorial / tutorial-management

An issues-only repository for overarching management of BSSw tutorial development and presentation
0 stars 0 forks source link

Decide how to handle per-tutorial web sites #1

Closed bernhold closed 3 years ago

bernhold commented 3 years ago

We want to be able to have a site site/space per tutorial to provide the latest updates, pointers to the hands-on lessons, additional resources, etc. at one easy-to-type URL.

The primary options would seem to be...

  1. Do this in the top-level https://bssw-tutorial.github.io/ site, probably using a separate subdirectory for each tutorial
  2. Generalize https://betterscientificsoftware.github.io/bssw-tutorial-sc20/ and use a separate repository for each tutorial
  3. Adapt the Carpentries workshop template https://bssw-tutorial.github.io/workshop-template/ and use a separate repository for each tutorial

We should be able to mix and match to some extent, taking the best elements of each.

bernhold commented 3 years ago

Another possibly relevant model to look at are the web spaces I've created for the HPC-BP webinars (https://github.com/ideas-productivity/hpc-best-practices-webinars, https://ideas-productivity.github.io/hpc-best-practices-webinars/) and the SWR panels (https://github.com/ideas-productivity/remote-work-panels, https://ideas-productivity.github.io/remote-work-panels/).

These were created with two goals in mind:

  1. Eventually to replace the corresponding parts of the ideas-productivity.org web site
  2. Utilize the structured information provided for each webinar/panel to generate the wide range of additional content and formats needed for the marketing and archival of the events.

You can see preliminary versions of the various kinds of content by exploring the links on the web sites. The underlying structure is fairly straightforward, implemented in stock Jekyll.

As part of replacing the i-p.o site with something Jekyll-based, we'd also need a replacement for the https://ideas-productivity.org/events/ page. Ideally, where we have information on the events already (e.g., webinars and panels), ideally, we would mine that to generate the Events page as well. If appropriately structured, tutorial event information that we might want in this context should be able to fit into the same model.

bernhold commented 3 years ago

For the present, we're working with a single top-level "tutorial web site" using Jekyll (https://bssw-tutorial.github.io/ backed by https://github.com/bssw-tutorial/bssw-tutorial.github.io) with a collection of "events" with one per tutorial. In addition, there is a separate directory per-event for more substantive content. (Initially, this is the hands-on exercises but we will probably refactor the event page.)

If/when we move the hands-on activities out to separate Carpentries-based repositories, this strategy will need to be revised. We'll need a way to capture the snapshots of the HTML from the repositories so that we can preset the appropriate version in perpetuity.

bernhold commented 3 years ago

The current Jekyll strategy with (basically) one page per tutorial event seems to work fairly well. I'm in the process of refining the way it is constructed so that it is (a) more automated, and (b) more flexible. But I think the basic approach is good. So I'm going to close this. We can always open a new issue if we decide we need to change things substantially.