carpentries / amy

A web-based workshop administration application built using Django.
https://amy.carpentries.org
MIT License
113 stars 72 forks source link

Import Trainee checkout progress to AMY #1615

Open maneesha opened 4 years ago

maneesha commented 4 years ago

Right now, to get credit for making a contribution to one of our GitHub repos as part of their instructor training checkout, trainees need to email us a link to their contribution, and then we manually record it in AMY.

To make this easier, we are proposing using GitHub's API to search for any contribution a pending trainee has made to our GitHub repos. We would take the latest contribution (if multiple ones exist) and count that towards the trainee's checkout, so they do not have to email us.

I can write a script that pulls all pending trainees' info from AMY, and checks it against our GitHub repos. @pbanaszkiewicz If we had a csv with the following fields, would it be possible to set up a function to import into AMY? If not, what else might we need?

  1. Person identifier (github id)
  2. Link to GH contribution
pbanaszkiewicz commented 4 years ago

Hello @maneesha,

Assuming the outcome of AMY import function would be to create a training progress with type=LC/DC/SWC homework, we need to additionally know which one is this: SWC, DC, or LC homework?

It's possible to add a "bridge" homework type, ie. "Homework", and assign Training Progresses to this. Additionally we should extend conditions for finishing training to include this new "Homework".

maneesha commented 4 years ago

Thanks for bringing up the homework type. I didn't mention that we are also moving away from having lesson program specific contributions, and allowing trainees to contribute to any active Carpentries repo. So we could do, as you suggested, have a "Homework" type - and then we'd want to deprecate the lesson program specific options.

maneesha commented 4 years ago

Note that we would still want to keep the lesson program specific options for the Demos but not for the Homework.

maneesha commented 4 years ago

Thinking about this more, I think it would be useful to expand this a bit so that we can include all steps of the checkout process.

So the file to import would have the following:

maneesha commented 3 years ago

This was part of a pre-pandemic project to restructure and streamline the instructor training checkout process. We are tabling this until we discuss more internally.