internetarchive / internetarchive/openlibrary

Add “Librarian note(s)” field to entities

Open
#9,452 4 comments 0 reactions 0 assignees View on GitHub
Lead: @cdrini Needs: Breakdown Needs: Detail Priority: 4 Type: Feature Request
Dominant language
Python
Stars
6.7k
Forks
2k
Avg merge
2d 19h
Merged PRs (30d)
138

Description

### Problem

### A clear and concise description of what you want to happen

Add a “Librarian notes” field for (Librarian) editable entities.

### Expected behaviour / screenshots (ex: Figma design screenshots for UI feature)

![screenshot of part of an Edition editing page, showing various text box entries](https://github.com/internetarchive/openlibrary/assets/177659/62c38890-16ca-4aaf-8a1e-2204b1cf4837)

There should be a “Librarian notes” text box too.

It would be nice if any entered “Librarian notes” would be displayed somewhat prominently on the entity page too, so fellow Librarians can easily see that there are notes for that.

### Additional Context

Sometimes a Work, Edition, or Author can have had a good deal of research put into it, but Librarians have no way to present this to other Librarians currently in a way that isn’t patron-facing. This means that hours of research etc. is either stored in a “wrong” (e.g., patron‐facing) place, only stored with the Librarian(s) who did the research, or… just gone.

Coming from *Brainz land I am used to an "Annotations" field on pretty much all entities which is for all sorts of notes (as well as edit/revision notes actually allowing for pretty lengthy and descriptive details about the sources and reasonings behind any given edit/change), so I assumed (and wrongly so!) that the `notes` field would be a good place to store such information. However, OL’s policy is much more aligned with hiding the gritty details of the librarian/metadata detective work from “regular users” (patrons), which is probably how regular libraries also operate.

### Proposal & Constraints

### What is the proposed solution / implementation?

Adding a `librarian_notes` text field in addition to existing `notes` and `description` fields, the contents of which should be shown to Librarians viewing the entity but not to regular patrons.

### Is there a precedent of this approach succeeding elsewhere?

screenshot of Goodreads’ “Librarian note” interface
Goodreads has such a system, though the notes are only shown when actually editing the items, not shown to GR librarians when browsing items.

### Which suggestions or requirements should be considered for how feature needs to appear or be implemented?

UI/UX considerations for how it’s shown to librarians. (This could potentially be a different issue, with this/the first issue being to just create the `librarian_notes` fields at all.)

### Leads

### Related files

### Stakeholders


### Instructions for Contributors

- Please [run these commands](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#working-on-your-branch) to ensure your repository is up to date **before** [creating a new branch](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#making-changes-and-creating-a-pull-request) 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.