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 Detectors, Categories, and DetectorCategories to administrate dashboard #105

Merged
merged 3 commits into from
Sep 18, 2024

Conversation

matt-bernhardt
Copy link
Member

@matt-bernhardt matt-bernhardt commented Sep 16, 2024

This adds Administrate dashboards to manage records in the Detector, Category, and DetectorCategory classes. The default dashboards have been lightly customized in a second commit to focus on the changes. These are focused on making the records easier to manage without remembering record IDs.

A side effect of this change is updating the annotations for the algorithm classes, which got out of sync somewhere.

Developer

Ticket(s)

https://mitlibraries.atlassian.net/browse/TCO-85

Accessibility

  • ANDI or Wave has been run in accordance to our guide and
    all issues introduced by these changes have been resolved or opened
    as new issues (link to those issues in the Pull Request details above)
  • There are no accessibility implications to this change While these dashboards have an a11y component to them, we have chosen to use them as-is with other models - so if there is an accessibility concern to these specific dashboards, it is likely something wrong with Administrate as a whole

Documentation

  • Project documentation has been updated, and yard output previewed
  • No documentation changes are needed

ENV

  • All new ENV is documented in README.
  • All new ENV has been added to Heroku Pipeline, Staging and Prod.
  • ENV has not changed.

Stakeholders

  • Stakeholder approval has been confirmed
  • Stakeholder approval is not needed

Dependencies and migrations

NO dependencies are updated

NO migrations are included

Reviewer

Code

  • I have confirmed that the code works as intended.
  • Any CodeClimate issues have been fixed or confirmed as
    added technical debt.

Documentation

  • The commit message is clear and follows our guidelines
    (not just this pull request message).
  • The documentation has been updated or is unnecessary.
  • New dependencies are appropriate or there were no changes.

Testing

  • There are appropriate tests covering any new functionality.
  • No additional test coverage is required.

** Why are these changes being introduced:

The dashbaords for detectors, categories, and detector_categories need
to be customized to make them useful.

** Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/tco-85

** How does this address that need:

This does a few different things:

* Ensures that the dashboards for Detectors, Categories, and
  DetectorCategories appear in the administrate sidebar. These links are
  in a cluster, and I've added code comments to the routes file to
  clarify the routes (these clusters may also inform our later roles
  work)

* Customizes the dashboards for these resources, positioning the name
  fields more prominently. The display text for these resources is also
  customized, using names where possible (including, for the linking
  class, the name of the two records being linked).

** Document any side effects to this change:

Hopefully having the second commit in this PR focus on the changes,
while the first commit just implements the output of the generator,
will make this easier to review.

Ulimately, I think a bespoke UI may make some of this management
easier, but we're trying not to focus on this sort of work at this
point.
@mitlib mitlib temporarily deployed to tacos-api-pipeline-pr-105 September 16, 2024 18:43 Inactive
@mitlib mitlib temporarily deployed to tacos-api-pipeline-pr-105 September 16, 2024 18:58 Inactive
@matt-bernhardt matt-bernhardt marked this pull request as ready for review September 16, 2024 18:59
@JPrevost JPrevost self-assigned this Sep 17, 2024
@matt-bernhardt matt-bernhardt merged commit f36107b into main Sep 18, 2024
3 checks passed
@matt-bernhardt matt-bernhardt deleted the tco-85 branch September 18, 2024 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants