Request a New Dataset for QA
!!!!DRAFT!!!!!
This is a guide for LD4P2 Partners (cohort and PCC affiliates included) on how to request a new dataset to be added to QA so corresponding lookups can be added to Sinopia (the LD4P2 supported BIBFRAME editor).
Email Steven Folsom (sf433 @ cornell dot edu) with related questions or comments on how to improve this guide.
Steps
1.) Make sure the dataset is not already in QA
Go to the Authorities tab on http://elr37-dev.library.cornell.edu/ (a temporary site until http://lookup.ld4l.org/ is live) to see if the dataset of interest is already available in QA.
2.) Identify the dataset
Identify the dataset and gather information about how to acquire data dumps and/or API access. (You will be asked for this information along with the dataset's homepage URL when making a formal request as GitHub issue, see Step #.)
3.) Decide what contextual information should be provided as a lookup
As you might know by now, QA has the ability to provide contextual information about an entity (not just preferred labels) during the look-up experience. In order to do so, decisions need to be made about how to index the dataset's RDF. Using this spreadsheet, add a tab for the new dataset. For each new tab, please use the following column headers and value guidelines (see the existing LCGT tab as an example):
| EntityType | PropertyPath | Search | Display | RankingNotes |
| URI for the class being described | URI for the property or property path to get to the information to be indexed in QA | Use an 'X' to mark when this data should be used to search against. N.B. some data is important to display, but perhaps wouldn't be useful to search against in a lookup. | Use an X to mark when the value should be displayed. Include a label for the field. This may be the property name in the property path column or you may decide another term is more appropriate | If applicable provide notes on whether a particular property path should weigh heavier on the search rankings. |
4.) Add Test parameters using a YAML file
In order to make sure
Plenty more to add before ready to promote...
