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

Update media list admin view to add ES-powered search #4656

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Jul 25, 2024

Fixes

Partially addresses #3841 by @stacimc

Description

This PR

  • adds advanced search to media list view, powered by Elasticsearch
  • adds source/provider filters to media list view

Combined with the bulk moderation action added in #4654, the linked issue is fully resolved.

Testing Instructions

  1. Check out the PR and run the API.
  2. Visit the admin page for image list (or audio list).
  3. Search for the following:
    • a specific UUID 3b858852-67df-44e1-8d57-683991d3ec67
    • a specific creator creator:"Al S"
    • a creator with wildcard creator:Al*
    • a word in the document cat
    • a word in a specific field tag.name:cat
  4. Combine your searches with a source/provider filter from the right sidebar for further narrowing.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb requested a review from a team as a code owner July 25, 2024 04:57
@dhruvkb dhruvkb requested review from krysal and obulat July 25, 2024 04:57
@openverse-bot openverse-bot added 🧱 stack: api Related to the Django API 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 💻 aspect: code Concerns the software code in the repository labels Jul 25, 2024
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

This is excellent, I think however instead of only recommending query string syntax for advanced search, that specific functionality should be documented. The examples from your PR description may be sufficient!

This is meant to cover this note in the issue and IP:

this field should have helptext reminding the user to also filter by provider in order to disambiguate a specific creator.

But also, I think this type of documentation and examples will make this much easier for moderators to remember.

Side note: /admin/api/image/ still times out with a 504 in production. Are there any plans in the remaining issues for this moderation project to make that page work, or an issue you're aware of to capture that problem?

@dhruvkb
Copy link
Member Author

dhruvkb commented Jul 26, 2024

@zackkrida since the examples and explanation for the search functionality might be a bit too long to fit below the search box, would you recommend I make a separate page for this in the docs and link to it from the search bar help text?

That page could document all the different search options from the PR explanation as well as the note about disambiguating a creator by filtering by providers.

Side note: /admin/api/image/ still times out with a 504 in production.

Bizarre. There aren't any open issues for that page to be fixed because afaik, those should've been fixed by @AetherUnbound's PR #4349. I'll try to take a look as well.

@dhruvkb dhruvkb marked this pull request as draft July 26, 2024 06:24
@zackkrida
Copy link
Member

@dhruvkb I think some of the value comes from these notes being inline and quick to access for moderators. A page is acceptable but my preference would be text directly on the page. The default font size is so small that a lot of text only takes up a few lines. Additionally, I had an idea: Using a <details><summary>Examples<summary><ul><li>Example 1</li></ul></details> block would be an elegant way to show a collapsible list of examples! Put together it all looks something like this:

image

I'll support any approach, however.

@dhruvkb
Copy link
Member Author

dhruvkb commented Jul 26, 2024

Great idea to use <details>, implemented in 3d4d094.

@dhruvkb dhruvkb marked this pull request as ready for review July 26, 2024 12:10
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

Looks great!

@dhruvkb dhruvkb merged commit 4aec507 into main Jul 26, 2024
54 checks passed
@dhruvkb dhruvkb changed the title Update admin views to aid bulk moderation Update media list admin view to add ES-powered search Jul 26, 2024
@dhruvkb dhruvkb deleted the bulk_views branch July 26, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🌟 goal: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants