hyrax icon indicating copy to clipboard operation
hyrax copied to clipboard

Make OAI-PMH support tested and clear

Open julesies opened this issue 6 years ago • 7 comments

Descriptive summary

The blacklight OAI Provider now works with Hyrax and a few institutions are using it (or at least one in prod :) ) so can we figure out what needs to happen next? Do we need to test with Nurax, document, promote, etc?

https://github.com/projectblacklight/blacklight_oai_provider

julesies avatar Oct 11 '18 19:10 julesies

@jlhardes, looks like this ticket needs decisions about next steps.

rjkati avatar Sep 09 '21 19:09 rjkati

It doesn't look to me like this is something Hyrax has available by default. We need to test to know if it is still possible to install and run on Hyrax. I can try locally and see how far I get. If it seems to be working, I think it could be worth it to add a pointer in Hyrax documentation to the blacklight_oai_provider instructions (probably on the Samvera KB site) for those who are interested or need that functionality.

jlhardes avatar Sep 10 '21 14:09 jlhardes

I did not get far with the Docker build locally. So even if this does work with Hyrax it is more involved than just pointing to the blacklight_oai_provider documentation to install and run. I think Hyrax documentation will need to include how to incorporate this gem as part of our current build process (Docker or helm). @julesies is there a possibility that any institutions running this have documentation available on how they did it or how this can be added as part of a build process for Hyrax?

jlhardes avatar Sep 10 '21 17:09 jlhardes

Hi all, we just integrated the blacklight_oai_provider gem into our Hyrax-based repository here at Duke: https://gitlab.oit.duke.edu/ddr/rdr/-/merge_requests/108/diffs

One thing to be aware of is that the OAI-PMH endpoint will throw an exception if there's no objects in the repository, you can see my fix for this issue here: https://github.com/projectblacklight/blacklight_oai_provider/pull/33

ryanfb avatar Nov 29 '21 19:11 ryanfb

At the SMIG meeting today, there was some discussion about what kind of OAI support if any is available by default for Hyrax, and agreement that documentation similar to what @jlhardes suggests would be beneficial.

agoslen avatar Feb 22 '22 20:02 agoslen

Thanks @ryanfb and @agoslen! I think it would be great if SMIG wants to write up documentation for options to implement OAI-PMH on Hyrax. Let me know how I can help move that along.

jlhardes avatar Feb 25 '22 16:02 jlhardes

Oregon Digital's OAI implementation looks like another example: https://github.com/OregonDigital/oregondigital/wiki/OAI-Documentation

jlhardes avatar Mar 22 '22 14:03 jlhardes

@jlhardes Hopefully, the new OAI-PMH documentation ([https://samvera.atlassian.net/wiki/spaces/samvera/pages/2251751437/OAI-PMH+Documentation]) is helpful.

acklose avatar Nov 07 '23 23:11 acklose

@acklose that is terrific, thank you SMIG!! I think this works to complete what is needed for this issue. @rjkati what do you think about closing this issue?

jlhardes avatar Nov 09 '23 20:11 jlhardes