CodeRefinery Open House, October 2, 2020

Time: 9:00-12:00 (CEST) / 10:00-13:00 (EEST)
Place: Video link
Relevanat zulip chat topic

Goals

decide how to make lessons citable
how to make lesson contributors are attributed
workshop contributors are credited

Lesson contributions

Methods

List up contributors for each lesson -> All contributors
Tributors to generate Zenodo (may need a bugfix to tributors)
from time to time we do releases and get a DOI

How/Where will it be presented?

on the rendered lesson page:
- It should work with cicero/remarkjs but needs to work with Sphinx and Jekyll
on the lesson github readme
on zenodo if somebody visits the DOI
somewhere on coderefinery.org (about page) -> script/workflow which visits all lessons' repos and gathers the data

Where will we track the information primarily?

either in .allcontribs and generate .zenodo.json from it? (adv: we can use the bot) <- i guess this is what we would do
we use primarily .tributors and generate .allcontribs and .zenodo.json from it? (we would not use the bot, I guess)

Workshop contributions

The info is already scattered around but we want to aggreagate the info.

How the result should look:

list of workshops
list of contributors
for each workshops: contributor
for each contributor: make it possible to list workshops

Where will it be collected?

in coderefinery.org

What info:

helpers
instructors including lessons
how many participants
other roles: host, zoom host, hackmd host

How will the information be tracked in workshop repositories?

allcontributors?
own ad-hoc?

Suggestion:

we use allcontribs with custom types (but this does not fit data about the workshop itself, e.g. number of participants)

Miscs.

This is an important but perhaps separate problem (to simplify reporting):
- num of participants, maybe with mapping country->number into separate file, country where it is held
We may end up with two files: one for contributions and one for meta-information
On coderefinery.org we will have a script/action which fetches the information.

Conclusions

for lessons we use allcontributors and tributors, we track this in the lesson repos
for workshops we use allcontributors with custom fields
custom fields are:
- host
  - can it be an organization also?
- instructor
- helper
- expert helper
- hackmd host
- zoom host
- coordinator
we should start with one lesson and two workshops (one online and one in-person), and then we add more
Radovan will make a suggestion for a meta-info yaml file for workshops

Links/examples

Tributors:
https://github.com/con/tributors

Galaxy example:
https://training.galaxyproject.org/

All contributors:
https://github.com/all-contributors/all-contributors

rkdarst's test:
https://rkdarst.github.io/all-contributors-test/about/
https://github.com/rkdarst/all-contributors-test/