OBOFoundry.github.io
OBOFoundry.github.io copied to clipboard
OBOFoundry
feat: dashboard status indicator
Made a couple small tweaks on top of work from @erik-whiting --
- Sort the big ontology table by default -- by dash status, then ID. The screenshots below sort dash status more granularly (e.g. "info" comes before "warn") just for kicks but I think that's probably not necessary.
- Some light refactoring of associated methods
- (provisional) add dashboard status badge. more on that:
For now I just pulled the same badge that's already present on the ontology details page (e.g. /ontology/fbdv.html)
- @matentzn had suggested putting it under the "social" column. totally doable, but then it becomes a little funky that you can't re-sort the table back to its original orientation (these are silly UX things that probably no one will ever actually care about)
- it's a little repetitive to say "OBO dashboard QC" on every single badge on every single row. Could reduce to "QC" or eliminate the label entirely. Could also do a different label that just says "pass"/"info"/"warn" like a typical CICD badge.
- the non-error badges are currently broken (see screenshot for example).
Otherwise, the other thought re: badges was to put them under "reuse":
In this case, I think it'd be nice to do some slimming on them to come closer to the width of the license badges.
This looks wonderful @jsstevenson !! Fantastic!
- Can you make a PR on https://github.com/OBOFoundry/OBO-Dashboard/blob/0af8ac6da43e6607c9a1eecb52a820d00438abca/util/lib.py#L543 to fix the dashboard badge to something reasonable
- For now, can you remove the "OBO Dashboard" bard of the badge label to be just "QC"?
- I prefer both badges in the re-use column for now but this is not my call. Can you generate both the screenshots again with the updated badge labels, add one screenshot entirely without a badge, and I will create a vote for OFOC to decide.
THANKS!
In this case, I think it'd be nice to do some slimming on them to come closer to the width of the license badges.
Ok, agreed! Whatever you can do to make it look a bit more homogenous. Having the rows higher is not a problem!
Re 4/16 call -- consensus on badge just saying "QC", embed in "re-use" column
Finally circling back -- implemented requests from 4/16 call, made some style tweaks, handle some broken links:
Two other notes (+ some example screenshots): badges can also say "Processing error: build dashboard" or "Failed to compute base" [presumably in cases where there's some error in the dashboard build process]. I have these badges linking to the base dashboard rather than the individual ontology dashboard page (since it doesn't exist when the build fails). That said, these badges end up widening the column significantly -- maybe they could be pared down on the obofoundry/obo-dashboard side in another issue?
And a final to-do for me: obsolete/inactive badges should be removed entirely (does that sound okay?)
Awesome, I love it! We will run it by OFOC for the last time today and then - is it ready to be merged?
@matentzn almost -- I just need to plug in a hard link to the dashboard results JSON file (for some reason I couldn't find it yesterday, but checked today and it is... right there)
I would say:
- a single default qc badge we can store somewhere which says:
NAfor ontologies that dont have qc. being run - In OBO-Dashboard we should drop the "WARN" from the badge if an "ERROR" exists to make the badge shorter. Similarly the processing error text should be simply changed to FAILURE
GREAT work!
- Add a static badge (defined in
assets/json/) for obsolete ontologies/anything that doesn't show up in the dashboard. I may end up needing to hotfix the exact URL since it the file won't be in a linkable location until this PR is merged but I think I got it right. - Link output to dashboard JSON output
@jsstevenson can you provide an updated screenshot for the review? Thank you!