Skip to content

Conversation

matt-bernhardt
Copy link
Member

@matt-bernhardt matt-bernhardt commented Apr 11, 2023

This is a more-polished set of changes to support the path we've identified for the Music Oral History resource. Specific changes include:

  • Adds post types (via child plugins of Mitlib Post) for Interview and Interviewee records, following the pattern established for other post types.
  • Adds a page template for the Child theme to support rendering of Interview records. This is a stub for now, and will be built out more completely as part of LM-331.
  • Removes the Tablepress plugin, and the MOH stub theme, from the application. The path we've identified no longer requires either of these.

Details of each of the above items can be found in each of the three commits on this branch.

This work is also supported by a review app I've prepared, which is described in more detail in the linked Jira ticket, to show what becomes possible based on this proposed change. I'd recommend reading the latest comment on that ticket for information about the content-side changes that I took as part of that.

Relevant ticket(s):

Developer

Secrets

  • No secrets are affected

Documentation

  • No documentation changes are made (don't think any are called for)

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)

Stakeholder approval

  • Stakeholder approval is not needed (I've talked with the project team throughout, but have not asked UX for a review of the review app for this branch)

Dependencies

YES dependencies are updated (a third-party plugin is removed)

Code Reviewer

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

@matt-bernhardt matt-bernhardt changed the title Quick attempt at Interview post type Add Interview and Interviewees post type, and Interview page template Apr 12, 2023
@matt-bernhardt matt-bernhardt requested a review from JPrevost April 12, 2023 20:48
@matt-bernhardt
Copy link
Member Author

A quick postscript about CodeClimate. Four of the five flags are in the "thanks, we need to tune your operations better" category (code repetition flagging block comments? really?) The fifth, about some whitespace in the interview template, will get resolved when we completely rebuild that template as part of LM-331.

** Why are these changes being introduced:

* The application needs content types for Interview and Interviewee
  records, in order to support content from the Music Oral History
  site.
* Those post types need to be built in the same approach that we used
  for other post types, such as the Bibliotech articles, Location and
  Expert records, or Exhibits.
* The legacy site used a different set of plugins to achieve this
  purpose, but we believe that this will not pose an insurmountable
  problem.

** Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/lm-298

** How does this address that need:

* This adds locally-written plugins that add post types for Interview
  and Interviewee records. Each has its own plugin, with fields
  defined by a JSON file inside the Mitlib Post plugin's data folder.
* The Child them also gets a new page template to minimally render
  the Interview post type. This will need to be built out more fully
  as part of LM-331 - right now it just shows a handful of fields
  in a table display, while the legacy MOH theme has a much more
  complex structure.
* The Interviewee post type does not have its own display - these
  records are instead shown in context by the Interview post type.

** Document any side effects to this change:

* There should be no side effects, but I wanted to note that the
  fields here were originally defined by plugins which we are
  retiring - TablePress was used for some repeating values, while
  Toolset Types was originally used to define most of the fields.
** Why are these changes being introduced:

* The Tablepress plugin is no longer needed by this application, as the
  only content it managed (some tabular data that was part of the Music
  Oral History site) is being moved into ACF-managed repeater fields.

** Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/lm-298

** How does this address that need:

* This removes TablePress. No other changes are needed, as the Pantheon
  application has not yet had any content imported into TablePress.

** Document any side effects to this change:

* None
** Why are these changes being introduced:

* The Music Oral History site on the network is being imported to this
  application in such a way that it will be rendered using the Child
  theme, so the stubbed "mitlib-moh" theme which we'd started to define
  will no longer be needed.

** Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/lm-298

** How does this address that need:

* This removes the mitlib-moh theme.

** Document any side effects to this change:

* None
@matt-bernhardt matt-bernhardt merged commit 32acb09 into master Apr 13, 2023
@matt-bernhardt matt-bernhardt deleted the moh branch April 13, 2023 15:08
matt-bernhardt pushed a commit that referenced this pull request May 10, 2023
* create a new function to check jq
if jq doesn't exist, look for brew or apt-get. if neither of those exist, exit hard.

* update the command

* [BUGS-6035] Adding upstream .lando file for installation of 'jq', 'npm', etc. (#83)

73:Adding upstream .lando file for installation of 'jq', 'npm', etc.

* add link to jq downloads page

* require shellcheck
this might mean we need to tweak some of the gh actions to ensure shellcheck is installed there, we'll see if this fails...

* update the composer scripts & add the lint script

* suggest installing jq manually

* ignore shellcheck unused vars for colors

* shellcheck linting suggestiosn

* actually lint

* comment out color/style variables we aren't using

* replace == with -eq

* switch back to == because it's required

* switch -eq back to ==

* use fewer conditionals

bail early and often if we've met our conditions

Co-authored-by: Phil Tyler <philip@tylerdigital.com>

---------

Co-authored-by: Charles Leverington <charles.leverington@gmail.com>
Co-authored-by: Phil Tyler <philip@tylerdigital.com>
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.

2 participants