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

Refactor Community Reviews (Observations) to use Tags #10324

Open
4 tasks
mekarpeles opened this issue Jan 12, 2025 · 2 comments
Open
4 tasks

Refactor Community Reviews (Observations) to use Tags #10324

mekarpeles opened this issue Jan 12, 2025 · 2 comments
Assignees
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Priority: 3 Issues that we can consider at our leisure. [managed] Type: Epic A feature or refactor that is big enough to require subissues. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]

Comments

@mekarpeles
Copy link
Member

mekarpeles commented Jan 12, 2025

Proposal

If one clicks to add a review...

Screenshot 2025-01-12 at 4 11 54 AM

A modified modal should open that shows some examples and allows the patron to search (and/or suggest new tags); something like:

Screenshot 2025-01-12 at 4 23 26 AM

The observations table should be modified to use a single value, which is the Tag key rather than the existing label and value pairs:
https://github.com/internetarchive/openlibrary/blob/master/openlibrary/core/schema.sql#L76-L77

The community reviews form should also open after the patrons adds a star rating, asking them if they want to add any tags to help other patrons evaluate whether the book is right for them.

Justification

  1. Community Review Tags aren't in the search engine (and are useful)
  2. The "Observations" naming is confusing Document what the Observation Form does #10319
  3. Community reviews are currently their own system (maintainability)
  4. Community reviews form currently require multiple levels of categories and clicking, which should be collapsed into single tags (e.g. instead of hypothetical cases like "pace" -> "fast", it should appear as "Fast Paced" and use the Tag "community: fast paced"

Breakdown

Requirements Checklist

  • Switch observations db schema to
  • Update observations UI to search for tags by name (drop "community:" from tag prefix)
  • Open review form automatically after patron star rates book
  • Add documentation re: Document what the Observation Form does #10319

Related files

@mekarpeles mekarpeles added Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed] Priority: 3 Issues that we can consider at our leisure. [managed] Type: Epic A feature or refactor that is big enough to require subissues. [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] labels Jan 12, 2025
@mekarpeles mekarpeles added this to the 2025 (Provisional) milestone Jan 12, 2025
@techy4shri
Copy link
Contributor

Is this issue supposed to be tackled by one assignees or multiple people?

@github-actions github-actions bot added the Needs: Response Issues which require feedback from lead label Jan 15, 2025
@mekarpeles
Copy link
Member Author

mekarpeles commented Jan 15, 2025

This is an epic, i.e. A tracking issue for a larger project. Epics are owned by individuals who project manage them to completion and almost always this is limited to staff, leads, or fellows w/ their mentors. A part of the process of leading an epic is breaking it down into sub issues that then get coordinated with the rest of the community

@mekarpeles mekarpeles removed the Needs: Response Issues which require feedback from lead label Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lead: @mekarpeles Issues overseen by Mek (Staff: Program Lead) [managed] Needs: Breakdown This big issue needs a checklist or subissues to describe a breakdown of work. [managed] Priority: 3 Issues that we can consider at our leisure. [managed] Type: Epic A feature or refactor that is big enough to require subissues. [managed] Type: Feature Request Issue describes a feature or enhancement we'd like to implement. [managed]
Projects
None yet
Development

No branches or pull requests

3 participants