mkdir-washington-edu commented 3 years ago

Give tools to support to handle incorrectly equated documents.

Now that OSF has fixed the Hypothesis integration on their end, we still need a way to correct the documents equated before the fix.

Per these Slack conversations, we've decided to build on to the admin product to provide a safe interface for this.

Ideas

Individual broken doc lookup

flowchart
  subgraph publisher
    report(Report a broken annotation via email)
    fixed(The annotation does not show up)
  end
  report --> lookup
  subgraph support
    lookup(Looks up doc URL of the broken annotation in h/admin) -->
    approve(Decides it's wrongly equated) -->
    break_pdf(Unlinks the PDF fingerprint and URL) & break_url(Unlinks doc 1 from doc 2)
  end
  break_pdf & break_url --> fixed

Notes

Background info

A gist that summarizes the issues from OSF's point of view: https://gist.github.com/felliott/758af271ceb13d7a10700597dbf254bb
JavaScript code in the OSF PDF viewer that does the aforementioned overriding: https://github.com/CenterForOpenScience/modular-file-renderer/blob/20.0.1/mfr/server/static/js/mfr.child.hypothesis.js#L28
Example of an affected article: https://osf.io/preprints/metaarxiv/cd5j9/

Improve flagging feature to include unequal document reports?

As designed, publishers would need to provide support the trouble annotations and documents.
Alternatively, we would include a flag dropdown to say, e.g., "Highlight on wrong document"
We want to do this anyway to reduce the number of false moderation reports

1 is probably easier to do and will require less of a deep dive than also implementing #2.

hypothesis / product-backlog

Spike: Create Hypothesis admin tools that will allow us to fix incorrect annotation URLs or document equivalence issues #1223