openlibrary icon indicating copy to clipboard operation
openlibrary copied to clipboard

Add web books to the merge queue

Open scottbarnes opened this issue 1 year ago • 0 comments

Problem

A clear and concise description of what you want to happen

#6585 adds web books, but we need a way to add web books. To that end, we should extend the merge queue (i.e. CommunityEditsQueue) to accept web books, and then create an endpoint (say, /read/add) which, when visited with the appropriate permissions and parameters, would add the web book to the edition.

Preliminary questions:

  • How many web books are out there? How many are 'good' and what defines 'good' in this context?
  • How can we make web books easier to find? Currently one might use a query such as https://openlibrary.org/search?q=format%3A%22Web+book%22&mode=everything. Do they just need their own filter? Should they show up in carousels somewhere?

How is success defined? There are some knobs to turn here:

  • number of web books imported;
  • categories (e.g. educational) web books imported;
  • findability on Open Library (e.g. degree to which patrons say they're easy to find);
  • the frequency patrons search for or otherwise use web books; and
  • the frequency librarians add web books.

A possible definition of initial "success": 1,000 web books imported, at least 500 of which are educational/researchy, with a way to filter search results the web book format.

One challenge with respect to a 'use' related goal is that if web books don't have their own place that is "easy to find", people finding web books will likely hinge on people customizing their searches, which it seems many patrons do not do.

Initial development steps:

  • [ ] Add new CommunityEditsQueue type for adding acquisition
  • [ ] Create new /read/add?key=OL2123M&provider={JSON here} for reviewing/approving the addition of a new acquisition
    • [ ] Should have “Approve”, “Reject”
    • [ ] Should display the provider to-add in a non-editable view
    • [ ] Should display the current book providers as well (read-only) to avoid race-conditions between editors adding the same thing twice
  • [ ] Re-enable edit page “Web Books” section, but if not super librarian, ensure items added via this section are added to queue (with the URL pointing to the new endpoint) for reviewing
    • [ ] Note: All other edits on the page should carry through. E.g. if someone edits the description and adds a read URL, and then hits save, the description should be saved immediately, only the read URL should be queued for approval.
    • [ ] Have a line of text noting that edits to web book providers require approval before going live
  • [ ] Remove “Add web book URL” from /books/add

Proposal & Constraints

No response

Leads

Related files

Stakeholders


Instructions for Contributors

  • Please run these commands to ensure your repository is up to date before creating a new branch to work on this issue and each time after pushing code to Github, because the pre-commit bot may add commits to your PRs upstream.

scottbarnes avatar Jul 24 '24 21:07 scottbarnes