Home

Menu

Loading wiki pages...

View
Wiki Version:
<h1>SHARE Maintenance</h1> <p>This document wil outline all tasks that need to happen in order for SHARE to continue to function as it stands, with community expectations being met.</p> <h2>Harvesters</h2> <h3>Harvester Registration</h3> <p>On average, we get about 4 or 5 external sources a week registering to be a provider for SHARE, not including tests or incomplete registrations.</p> <h5>Actions that need to be taken</h5> <ul> <li>Check registration page on a regular basis</li> <li>Evaluate completeness of the registration<ul> <li>Is it a test?</li> <li>Have they registered before?</li> <li>Are they confused about metadata license requirements?</li> </ul> </li> <li>If the registration is complete and all looks good:<ul> <li>Add registrant as a customer in Desk</li> <li>Send them an email using a template saying the registration is complete.</li> <li>Check off (and save) that the provider has been contacted on the SHARE Registration admin interface</li> <li>Continue the conversation as needed and follow up with any questions or comments they might have.</li> <li>Create a corresponding ticket in JIRA with all relevant information</li> </ul> </li> <li>If they look like they had trouble with the metadata questions (the registration will be complete, but metadata questions not all checked)<ul> <li>Add registratnt as a customer in Desk</li> <li>Send them an email using the "confused about metadata?" template</li> <li>Continue the conversation as needed about what they're confused about and what their needs are</li> <li>If their questions are answered, add their provider as a harvester ticket in JIRA</li> </ul> </li> <li>After the harvester has officially been added, go back into desk and inform the person that it's complete, and close the DESK case.</li> </ul> <h3>Harvester Creation</h3> <h4>OAI-PMH Harvesters</h4> <h5>Description</h5> <p>These are the simplest of the harvesters. They take only a little effort to write, and can be created in under an hour if all goes smoothly.</p> <p>Sometimes, however, a source's OAI-PMH endpoint behaves strangely. Problems we've seen include:</p> <ul> <li>date ranges returning the wrong sets</li> <li>oai_dc metadata format missing</li> <li>URLs lead to strange splash pages or are broken</li> <li>More URLs can be constructed using persistant identifiers</li> <li>DOIs hidden in descriptions or titles that need to be extracted</li> <li>Contributors presented in strange formats</li> </ul> <h5>Actions that need to be taken</h5> <ul> <li>Code review for the harvester<ul> <li>Are the short names appropriate?</li> <li>Tests working correctly?</li> <li>Correct sets harvested?</li> <li>Are the URLs returning correctly?</li> <li>Do we need to modify the URLs in any way to get access to the content we want?</li> </ul> </li> <li>Emailing the registrant with any questions we may have</li> <li>Merging the harvester into develop</li> </ul> <h3>Releases and hotfixes</h3> <p>Before new harvesters are visible to the public, there needs to be a release of scrapi containing all new harvesters</p> <h5>Actions that need to be taken</h5> <ul> <li>Code reviewed harvesters</li> <li>Releases<ul> <li>Harvesters merged into develop</li> <li>Release made via github</li> <li>Data harvested on the backend</li> <li>backend updated and restarted</li> </ul> </li> <li>Hotfixes<ul> <li>Harvester fixes made on master</li> <li>Migrations run to fix old data</li> <li>backend updated and restarted</li> </ul> </li> </ul> <h3>Breakadges and General questions from SHARE at Large</h3> <p>Many times, providers who have their sources in production have questions about SHARE - They ask for more information - They want their provider to be updated in some way - They want us to harvest more metadata Providers already in service break - APIs can change - URLs that once worked stopped working These in many cases require email correspondance with the original provider. They also require a new release or hotfix to be made to address the problem</p> <h3>SHARE Push API</h3> <p>As of right now, the SHARE push API is only deployed on staging. We have a group at uPenn who is very eager to see their data on SHARE production. Everything is already in place.</p> <h3>SHARE VIVO Harvester</h3> <p>The VIVO harvester has a pull request, but was left in an unknown state. It's possible we still need more information to run it, but it is NOT currently in operation, either in staging or production.</p> <h3>Things that require work but could be immensely helpful</h3> <ul> <li>The OSF SHARE page is an example, yes, but is very much more incresignly being used as THE place that people go for SHARE content.<ul> <li>Advanced search does not exist. People get confused how to use the API, and go to the search page to search for content.</li> </ul> </li> <li>API documentation is scattered<ul> <li>Docs are pretty thorough, but a little scattered between swagger and notes on many different OSF components. This could use a go over from an outside perspective to make things more unified.</li> </ul> </li> <li>Right now, the desk to person is manual. Desk has an API that could be accessed thru the SHARE registration page that would at the very least create a new case and fill in all of the parameters.</li> <li>We never formally did the "Metadata Audit" that conformed to our new understanding of the metadata schema. This maybe should happen before a host of new harvesters come into play. </li> </ul>
OSF does not support the use of Internet Explorer. For optimal performance, please switch to another browser.
Accept
This website relies on cookies to help provide a better user experience. By clicking Accept or continuing to use the site, you agree. For more information, see our Privacy Policy and information on cookie use.
Accept
×

Start managing your projects on the OSF today.

Free and easy to use, the Open Science Framework supports the entire research lifecycle: planning, execution, reporting, archiving, and discovery.