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 an ADR for how we approach the administrative interface #55

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

matt-bernhardt
Copy link
Member

@matt-bernhardt matt-bernhardt commented Jul 9, 2024

Why these changes are being introduced:

We need to decide how the application will handle content administration for its internal records. This includes both the records that will be created and managed within the app (fingerprinted phrases for hints, categorization notes), as well as - potentially - records received and stored for use (search terms, imported journal titles, etc).

Relevant ticket(s):

How this addresses that need:

This adds an architecture decision record to survey the available gems for content administration, and proposes a choice for how to proceed (to use Administrate for our initial use cases, but a bias towards leaving it behind rather than heavily customizing it as our needs become clearer).

Side effects of this change:

This decision might be a bit unorthodox, as it includes the choice to change implementations. That choice may be altered as we build experience with the application, or as the Administrate gem continues to develop.

@mitlib mitlib temporarily deployed to tacos-api-pipeline-pr-55 July 9, 2024 18:54 Inactive
@matt-bernhardt matt-bernhardt force-pushed the tco37-administration-ui branch 2 times, most recently from 215580a to 7b565b5 Compare July 12, 2024 14:13
@matt-bernhardt matt-bernhardt changed the title WIP towards admin ADR Add an ADR for how we approach the administrative interface Jul 12, 2024
This is the basic framework of the ADR, but I'm hoping to
fill it out a bit more through dialog with the other
engineers in EngX.
@matt-bernhardt matt-bernhardt force-pushed the tco37-administration-ui branch from 7b565b5 to a7dfed2 Compare July 12, 2024 14:51
@matt-bernhardt matt-bernhardt marked this pull request as ready for review July 12, 2024 14:52
@JPrevost JPrevost assigned JPrevost and unassigned JPrevost Jul 12, 2024
Copy link
Member

@JPrevost JPrevost left a comment

Choose a reason for hiding this comment

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

Agreed.

Using Administrate for anything it works for out-of-the-box and building our own interfaces whenever it isn't what we need is a good plan... as long as we hold ourselves to it in the future :)

Copy link
Contributor

@jazairi jazairi left a comment

Choose a reason for hiding this comment

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

I agree with the choice of Administrate here. It has its issues, but I'm sure that Active Admin, Rails Admin, Avo, et al all do as well. And we're familiar with Administrate, warts and all.

I also appreciate the warning against template customization. My sense is that, as soon as we start customizing any template, we should instead build that dashboard from scratch.

@matt-bernhardt matt-bernhardt merged commit e4e9a51 into main Jul 12, 2024
2 checks passed
@matt-bernhardt matt-bernhardt deleted the tco37-administration-ui branch July 12, 2024 20:44
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.

4 participants