Enhance environment for developers to more easily work on descriptive metadata processing

crkn-rcdr / cihm-metadatabus

Documentation and Docker build environment for key portions of the metadata bus.

BSD 2-Clause "Simplified" License

0 stars 1 forks source link

Enhance environment for developers to more easily work on descriptive metadata processing #19

Closed RussellMcOrmond closed 1 year ago

RussellMcOrmond commented 2 years ago

The library that accepts the XML files in MarcXML, DC and IssueInfo and extracts the JSON we use in cosearch/copresentation documents is in https://github.com/crkn-rcdr/cihm-metadatabus/tree/main/CIHM-Meta/lib/CIHM/Meta/dmd

What this library lacks is the type of work that was started with https://github.com/crkn-rcdr/cihm-metadatabus/tree/main/CIHM-Normalise , which is to have some test cases.

Proposal:

Move code from CIHM::Normalise into CIHM::Meta::dmd::Normalise
Create appropriate unit testing of the functions in the two packages
Create appropriate XML test examples for each of the 3 supported metadata formats (some failing, some succeeding with different aspects of functions being tested).
Update cosearch-copresentation spreadsheet, potentially migrating this documentation to GitHub first for future maintenance.

Testing should happen within Docker container, and should be able to run without external network or database access.

RussellMcOrmond commented 2 years ago

Prior to PASplit, https://github.com/crkn-rcdr/CIHM-METS-parse was also using the CIHM::Normalise module. That code should be cleaned up.

Maybe we want to create a PR for this cleanup and prep work separate from any work on MARC records? https://github.com/crkn-rcdr/cihm-metadatabus/pull/49

RussellMcOrmond commented 1 year ago

Added "good first issue". I suspect we aren't going to prioritise this for a current developer, but working on enhancing some of the documentation/etc may be good for a new developer to lean this environment.

We are pushing to replace this with other software, but that won't likely happen for another year or so.

RussellMcOrmond commented 1 year ago

Some of this work needs to be done earlier, to enable collaboration on updating our current Metadata Application Profile (MAP).

RussellMcOrmond commented 1 year ago

I still want to go through the cosearch-copresentation spreadsheet and see if there are important aspects to maintain. I want to document which fields go into cosearch vs copresentation, and exist in items (manifests/collectins) vs pages, as a separate table rather than making the existing tables wider
Some fields which are copresentation only aren't yet mentioned.

RussellMcOrmond commented 1 year ago

https://github.com/crkn-rcdr/cihm-metadatabus/commit/9580d48fe2a04940310d710e8e9942892c303bd0

Complete for now. More documentation updates will be desired in the future as the MAP moves closer to community tools we will be replacing custom CMR/CAP software with.