Sage-Bionetworks / dccvalidator

Metadata Validation for Data Coordinating Centers
https://sage-bionetworks.github.io/dccvalidator/
Other
9 stars 11 forks source link

Add button to notify curation team #434

Open kelshmo opened 3 years ago

kelshmo commented 3 years ago

Currently, dccvalidator pops up a modal when all files entered into the app pass all checks without error. This modal instructs the user to email xx "to proceed with the next step..."

In our experience, the user doesn't typically action on this step. Additionally, the modal will present when a user validates anywhere from 1 - 4 files; the user might not have completed the validation process.

A possible solution is to add a button that when selected, files a GH issue in a repo of choice. There are potential technical limitations here that @cw-dvr8 can further describe (e.g. the need for a GH token).

A potential drawback to a button might be that excessive issues are filed. A potential benefit is the follow-up action is contained in the app itself.

Aryllen commented 3 years ago

Would it be necessary to have it create a GH issue or would it be adequate to have the validator email the contact address? This could be an auto-email that sends every time they have no errors on validation. The email could have a list of the file names that were validated, or just a list of the metadataTypes for the validated files. An email would get around the problem of needing GH tokens for specific repos. It may also feel like spam if we get a lot of emails, but ultimately, email can be managed, be it through filtering or otherwise.

Another question I have is whether the ultimate goal is to make sure the curators know when the contributor has passed validation, or if it is to know if the contributor is attempting validation. If it's to know when the contributor passes validation (regardless of number of files validated), that is a rather simple email. If it's to know that they have begun/continued the process, that would make for a lot more issues/emails.

Overall, I do like the idea of having the app notify curators. The alternative is to check dccmonitor regularly (loading it twice since #361 hasn't been done, yet).