...
2.) Identify the new dataset
...
We'll need the name of the dataset and homepage URL.
N.B. You will be asked for this information when making a formal request as a GitHub issue, see Step 5 below.
3.) Gather Data Download and/or API
Provide a link to where to download the RDF dataset. A link to API documentation is needed if the authority does not have an acceptable download dump that can be ingested into services.ld4l.org
The requirements for the API are:
- URL that can receive a string query AND returns results as linked data
- URL that can receive a URI AND return linked data about the entity (The URL may be the URI for some authorities.)
N.B. You will be asked for this information when making a formal request as a GitHub issue, see Step 5 below.
...
4.) Decide how contextual information should be used
As you might know by now, QA has the ability to provide contextual information about an entity during the look-up experience. In order to do so, decisions need to be made about how to index the RDF descriptions of entities in the dataset.
...
| EntityType | PropertyPath | Search | Display | RankingNotes |
| URI for the class of entity in the lookup | URI/s for the property or property path to get to the information to be indexed in QA | Use an 'X' to mark if this data should be used to search against. N.B. some data is important to display to the cataloger, but perhaps would create messy results if searched against in a lookup environment, e.g. some notes are administrative in nature. | Use an X to mark if the value should be displayed. Include a label for the field. The label may simply 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 than others. |
5.) Create an issue to formally request the new dataset
a.) From https://github.com/LD4P/qa_server/issues/new/choose, create an issue by clicking on "Get started" for the Request a New Dataset for QA. You will be asked to provide the information gathered in Steps 1-4.
This will prompt the prioritization of the request, and (if prioritized) the initial set up of the dataset in QA. The requester will be then contacted and asked to create accuracy test parameters. No further action is required of the requestor until issue is updated to indicate the process is ready for Step 6.
6.) Add
...
Accuracy test parameters
...
in YAML file
In order to make sure the QA search behavior (recall and relevancy) are meeting expectations, QA uses YAML to define test parameters. These parameters include the ability to declare for a particular text string searched, the results should include a particular resource (identified by a URI) and what is the maximum position in the results the resource should be found.For example, when searching 'Casebooks' against LCGFT,
http://id.loc.gov/authorities/genreForms/gf2011026115 should be in the top 10 result.
N.B. You will be asked to confirm this has been done when making a formal request as a GitHub issue, see Step 5 below.
a.) Using a.) A link to a YAML file will be shared with the requestor via a comment in the issue in order to complete the Accuracy Test portion of Writing Tests for an Authority, create a YAML file for your dataset using a text editor. Follow the Save the file with the file extension .yml and upload to https://github.com/LD4P/qa_server/tree/master/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios..
b.) Alternatively, from the same page https://github.com/LD4P/qa_server/tree/master/lib/generators/qa_server/templates/config/authorities/linked_data/scenarios, create the YAML file using the GitHub "Create new" file feature.
5.) Create an issue to formally request the new dataset
a.) From https://github.com/LD4P/qa_server/issues/new/choose, create an issue by clicking on "Get started" for the Request a New Dataset for QA. You will be asked to provide/confirm the following:
Edit directly the YAML file in Github, save.
c.) Create a Pull Request to be reviewed. Be sure to including a meaningful commit message (e.g. adding accuracy tests for Authority X) [ ] Identify the data source: (Include the Data Source Name and its homepage URL)
[ ] Add a new tab and indexing information for the data source to the following spreadsheet: https://docs.google.com/spreadsheets/d/1rPvEoP9iYNkxJ0eWC8gXe3ci7e6mhW0da59xkGhadi0/edit?usp=sharing.
[ ] Add a YAML test file to https://github.com/cul-it/qa_server/tree/master/config/authorities/linked_data/scenarios; please provide here a link to the YAML file related to this request.