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 report creation, better filtering and more improvements to admin views for media #4414

Merged
merged 9 commits into from
May 31, 2024

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented May 30, 2024

Fixes

Fixes #4412 by @dhruvkb
Fixes #4413 by @dhruvkb

Description

This PR

  • updates the sidebar filter to show both moderation queue and all media items
  • enables the creation of reports from the media change view
  • makes code quality and interface improvements
    • use of descriptions as per Django admin UI
    • changing hardcoded URLs to {% static %}
    • showing helpful messages when reports/decisions do not exist

Testing Instructions

  1. Check out the PR and run the dev server.
  2. Go to the image/audio list, you should see the moderation queue by default.
  3. Click on "All" in the sidebar, you should now see all 5000 media items listed.
  4. Open an item that's not in the moderation queue, you should see descriptive messages in the report and decision list sections.
  5. Create a report using the form in the "Create report", the report should appear in the "Reports" section under it.
  6. Take a decision for the report using the "Create decision" section, the decision should appear in the "Decisions" section under it.

This way the complete flow for reporting and moderating any individual media item is present in one page. However moderation flow involving multiple media items cannot be accomplished using this process.

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 (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or 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 added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software 🔧 tech: django Involves Django 🧱 stack: api Related to the Django API labels May 30, 2024
@dhruvkb dhruvkb marked this pull request as ready for review May 31, 2024 07:59
@dhruvkb dhruvkb requested review from a team as code owners May 31, 2024 07:59
@dhruvkb dhruvkb requested review from krysal and obulat May 31, 2024 07:59
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Such improvements since the last time I looked at this code!

Do we really need to have a different word ("complain") for the reporting view? I think it would be easier to keep a single name.

By the way, would clicking "All" on the sidebar in production cause the huge query to break the API?

@dhruvkb
Copy link
Member Author

dhruvkb commented May 31, 2024

The main reason for using the word "complain" was that it is a verb that corresponds to the creation of a "report" model instance, similar to how the verb "moderate" corresponds to the creation of a "decision" model instance.

I wanted to avoid the potential confusion that can occur because "report" is both a noun and a verb, and also used in a number of places to refer to the ImageReport and AudioReport models together.

That said, I'm happy to change the name if more people feel the same way as @obulat.

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.

LGTM. I share @obulat's preference about the name, though. I don't consider it blocking, but "complain" is such a new concept to introduce that I can see it leading to confusion. I'd like to see either:

  • Comment(s) explaining the naming
  • An alternative name like "media_submit", "media_create_report", or something

@dhruvkb
Copy link
Member Author

dhruvkb commented May 31, 2024

Ok, I've replaced verbs "complain" and "moderate" with "report_create" and "decision_create" in commit f9a7402.

@dhruvkb dhruvkb merged commit 7e558ef into main May 31, 2024
45 checks passed
@dhruvkb dhruvkb deleted the add_report_form branch May 31, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🔧 tech: django Involves Django
Projects
Archived in project
3 participants