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

Project Proposal: Additional search views #1890

Merged
merged 11 commits into from
May 11, 2023
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# 2023-04-24 Project Proposal
fcoveram marked this conversation as resolved.
Show resolved Hide resolved

## Reviewers

- [x] @obulat
- [ ] @krysal
fcoveram marked this conversation as resolved.
Show resolved Hide resolved

## Project summary

The Openverse team has decided to enhance the browsing experience by
incorporating new content views for providers, tags, and creators. This feature
will allow users to share collections detached of individual searches.

## Goals

Search Experience

## Requirements

fcoveram marked this conversation as resolved.
Show resolved Hide resolved
The project adds three additional views for the Nuxt frontend where users
interact in the following ways.

### Results by tag

Users land on the tag results page by clicking on the tag in the single result
page or by opening a tag results link (for instance,
[www.openverse.org/tags/image/cat](https://www.openverse.org/tags/image/cat)).

The results page shows the name of the tag and all the items of the selected
media type that have this exact tag applied. The items are sorted by
`ingested_on` field in descending order.

For instance, the `cat` tag page will show only images that have the `cat` tag,
not items tagged with `cats` .
fcoveram marked this conversation as resolved.
Show resolved Hide resolved

### Results by source

Users land on the source results page by clicking on the source name in the
single result page or by opening a source results link (for instance,
[http://www.openverse.org/providers/wikimedia/image/](https://www.openverse.org/providers/wikimedia/image/))

The results page shows the name of the source and all the items from this source
in the selected media type. The items are sorted by `ingested_on` field in
descending order.
fcoveram marked this conversation as resolved.
Show resolved Hide resolved

### Results by creator

Users land on the creator results page by clicking on the creator’s name in the
single result page or by opening a creator results link (for instance,
[http://www.openverse.org/creators/cat_flickr](https://www.openverse.org/creators/cat_flickr))

The results page shows the creator’s name and the source where the content comes
from, and all items in the selected media type. The items are sorted by
`ingested_on` field in descending order.

### Changes

The three pages described above will require changes to:

- Nuxt frontend: Adding pages for the specific views by reusing the current
result layouts for each media type. The pages will only show the results,
without the ability to search within them. Because of that, the views will use
the "content" header (without the search bar, search type selection or filters
button) and will not have a filter sidebar.
- API: adding `filter` parameters that would enable retrieving all items of a
certain media type that have the specific property (tag/provider/creator and
source pair). These will work similarly to the way filter parameters such as
`license` work now, returning only the items with the specific filter.
Searching within the filtered items is not in scope of this project.

## Success

The project will be considered successful when:

- Each tag, provider, and creator has a standalone and shareable page.
- Page uses are tracked by derivating data from existing events.

## Participants and stakeholders

- Design: @panchovm
- Implementation:

## Infrastructure

fcoveram marked this conversation as resolved.
Show resolved Hide resolved
No infrastructure changes are required.

## Accessibility
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A call for the a11y team of the WordPress project for revision of the mockups would be nice here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Based on how the discussion unfolded, I will ping a11y folks in the design ticket.


## Marketing

fcoveram marked this conversation as resolved.
Show resolved Hide resolved
## Required implementation plans

- API
- Frontend
- Design issue