Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add web books to the merge queue #9624

Open
9 tasks
Tracked by #9582
scottbarnes opened this issue Jul 24, 2024 · 1 comment
Open
9 tasks
Tracked by #9582

Add web books to the merge queue #9624

scottbarnes opened this issue Jul 24, 2024 · 1 comment
Assignees
Labels
Affects: Librarians Issues related to features that librarians particularly need. [managed] Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] Module: Merge Queue Priority: 2 Important, as time permits. [managed] Theme: Trusted Book Providers Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]

Comments

@scottbarnes
Copy link
Collaborator

scottbarnes commented Jul 24, 2024

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 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 scottbarnes added Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed] Priority: 2 Important, as time permits. [managed] Affects: Librarians Issues related to features that librarians particularly need. [managed] Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] Theme: Trusted Book Providers Module: Merge Queue labels Jul 24, 2024
@scottbarnes scottbarnes self-assigned this Jul 24, 2024
@scottbarnes scottbarnes mentioned this issue Jul 24, 2024
16 tasks
@mekarpeles mekarpeles added this to the Sprint 2024-08 milestone Aug 2, 2024
@mekarpeles mekarpeles modified the milestones: Sprint 2024-09, 2024-11 Oct 25, 2024
@mekarpeles
Copy link
Member

Let's make it so only librarians can submit for now so we we have some trust about the sources being submitted for review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects: Librarians Issues related to features that librarians particularly need. [managed] Lead: @cdrini Issues overseen by Drini (Staff: Team Lead & Solr, Library Explorer, i18n) [managed] Module: Merge Queue Priority: 2 Important, as time permits. [managed] Theme: Trusted Book Providers Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]
Projects
None yet
Development

No branches or pull requests

2 participants