harvard-lil / h2o

H2O is a web app for creating and reading open educational resources, primarily in the legal field
https://opencasebook.org
GNU Affero General Public License v3.0
36 stars 30 forks source link

Evaluate the relative value of the "Finalize casebook" workflow #1943

Closed lizadaly closed 1 year ago

lizadaly commented 1 year ago

If a section or resource is added to a casebook in an uncertain state, it'll get assigned the resource_type of Temp, and show up in the UI with a red highlight:

image

This also triggers some (but not all) edit pages to disable the publish button and instead show a "Finalize entries" button, which will scroll the user down to the first matching entry in the temp state.

image

The easiest way to get a node into the temp state is to take a recently-edited section, select type "Legal doc", and then don't match it to a case or code.

Only 0.3% of content nodes are in this "temp" state. Maybe that's because this post-hoc audit UI is good at helping users fix it! Or maybe it just happens very rarely in practice because users note the angry red border and make adjustments immediately.

There's a lot of code devoted to the audit workflow, and it's possible it was more necessary in the past before the multi-stage Quick Add feature was refined (it works really well and if it matches only one case it auto-applies the audit step). There's definitely a bug somewhere in here, because Sentry reports a lot of errors coming from this component that are hard to reproduce. My instinct is that the "Finalize casebook" and audit process could be streamlined a bit as part of fixing the errors, and evaluated based on user feedback.