New Ontology Request (NOR) Manager
The New Ontology Request (NOR) Manager has these basic duties:
new ontologyrequests on the OBO Foundry GitHub issues tracker and acknowledging the receipt
- Including the ontology in the OBO New Ontology Request (NOR) Dashboard and updating the dashboard
- Supporting the New Ontology requestor to pass the OBO Dashboard
- Assigning a provisional reviewer from the OBO Operations Committee
- Removing the accepted ontology from the NOR Dashboard upon acceptance
new ontology requests on OBO and acknowledging the receipt
The NOR Manager MUST actively listen to issues on the OBOFoundry GitHub issues tracker.
When a new ontology request is received, and the wrong issue template was used, the NOR Manager must inform the NOR requestor to use the correct issue template and close the wrongly submitted issue with the following message:
Dear @GITHUBNAME, Thank you for your submission. However, the wrong issue template has been used. Please make sure to follow the [New Ontology Submission Instructions](https://obofoundry.org/docs/NewOntologyRegistrationInstructions.html) and use the [New Ontology Request issue template](https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?assignees=&labels=new+ontology&template=new-ontology.yml&title=Request+for+new+ontology+%5BNAME%5D). Thank you.
When a valid NOR request is received the NOR Manager acknowledges the receipt with the following message:
Dear @GITHUBNAME, Thank you for your submission. The review will be executed as a two stage process. First, you will have to pass [OBO NOR Dashboard](https://obofoundry.org/obo-nor.github.io/dashboard/index.html). Pass means that no check _apart from `Users` may be red_. After you have successfully passed the Dashboard you will be assigned an OBO Operations committee member to review the ontology. Usually, the review will result in an opportunity for you to improve the ontology. When the reviewer believes the ontology is ready for presentation to the OBO Operations Committee, they will present your ontology during an OBO Operations Call. This gives other members of the committee the opportunity to assess your work. When a decision is reached by the committee you will be informed here on the issue tracker. The process can take any number of weeks or months, depending on the case at hand. Please inform us about any reasons you might have for increased urgency. You will be informed once your ontology is loaded in the OBO NOR Dashboard. Good luck.
The NOR Manager must ensure that the requestors use the proper communication channels with the OBO community:
- Make sure that the requestors have joined and send an appropriate email to the obo-discuss mailing list (see the FAQ). If they have not, point them to the instructions and ask them to do so.
- Invite the requestors (using the email listed in the metadata) to the OBO Foundry Slack space (using the
Slack->Invite people to obo-communitymenu, adding the email provided.
Including the ontology into the OBO New Ontology Request (NOR) Dashboard and updating the dashboard
The OBO NOR Dashboard is managed here: https://github.com/OBOFoundry/obo-nor.github.io.
Integrating the submitted ontology into OBO dashboard means simply adding a new record into the
of the dashboard config file. Only information explicitly mentioned in the New Ontology Request should be used.
All modifications on obo-nor.github.io repository MUST be done via pull requests and NOT via direct commits on the master branch.
The /workflow/dahsboard.yml file must indicate the GitHubID of the actual NOR manager as assignee.
Every update (adding or removing an ontology) should proceed as follows:
- Creation of a Pull Request (PR) for modification of the dashboard config file for adding or deleting record in the
ontologies->customsection of the file.
- Once the previous PR is merged, it triggers the Update dashboard run GitHub action. This action can also be triggered manually here with the
- Once the run is complete, a new PR named
Update dashboard runis created. Manually check the diff, especially the /dashboard/dahsboard-result.yml file for inconsistencies.
- Finally, merge the
Update dashboard runPR. This PR should always be reviewed by the NOR Manager and not be automatically merged into the main branch as part of the GitHub action.
In addition, the Update dashboard run action is automatically triggered on Monday mornings and steps 3 and 4 must be performed afterward.
Supporting the New Ontology requestor to pass the OBO Dashboard
For many New Ontology requestors it is not always easy to interpret the warnings on the OBO Dashboard. The NOR Manager is responsible for supporting the requestor interpreting the dashboard (but not to fix the problems). There is no need to dig deep into the ontologies to diagnose problems - that is the requestors responsibility - but pointing to documentation like the OBO Foundry Principles may be necessary.
In addition, some checks need to be carried out manually by the NOR manager until sufficiently reliable automatic checks are available. A non exhaustive list includes:
URIs: check if it includes “https” and if it conforms with the overall format “http://purl.obolibrary.org/obo/ONTOLOGY_”
Release artefact: check if release artefacts are identified as such and ensure that, alongside a “main release”, a base release is provided which does not include imported terms.
Imports: Ensure that there is a mechanism in place to update imported terms (classes and properties).
During this process, all discussions between the requestors and the NOR manager must take place in the OBO Issue Tracker in the NOR issue created by the requestor.
Assigning a provisional reviewer from the OBO Operations Committee
If and only if the requested ontology passes the dashboard, i.e. no more “red” exists aside from the
Usage column, the NOR manager assigns the next available reviewer from the ‘OBO Operations Members’ sheet in the OBO Duty Rotation Table. The reviewer is assigned by
- Adding them to the ‘Ontology Review Rotation’ sheet in the OBO Duty Rotation Table
- Assigning the NOR GitHub issue to the reviewer
- Announcing the reviewer assignment to the OBO Operations Technical Working Group Liaison to include in their report at the next OBO Operations meeting.
Removing the accepted ontology from the NOR Dashboard upon acceptance
When the ontology is accepted, the OBO NOR reviewer needs to make sure that the accepted ontology is removed from the OBO NOR Dashboard.
Note 29.11.2022: There is a work in progress which can deal with this step automatically, but the responsibility still stays with the OBO NOR Manager.