Skip to content

Commit 848ae9f

Browse files
pfabrymatentzn
andauthored
Updated NOR manager role (#2396)
* Updated NOR manager role Added some tasks to be done manually. * Update docs/roles/RoleNORManager.md Co-authored-by: Nico Matentzoglu <nicolas.matentzoglu@gmail.com> * Update docs/roles/RoleNORManager.md Co-authored-by: Nico Matentzoglu <nicolas.matentzoglu@gmail.com> * Update docs/roles/RoleNORManager.md Co-authored-by: Nico Matentzoglu <nicolas.matentzoglu@gmail.com> * Update docs/roles/RoleNORManager.md --------- Co-authored-by: Nico Matentzoglu <nicolas.matentzoglu@gmail.com>
1 parent af7646d commit 848ae9f

2 files changed

Lines changed: 57 additions & 37 deletions

File tree

docs/SOP.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,15 @@ This document contains standard operating procedures (SOPs) for the OBO Foundry
1919

2020
### New Ontology Requests (NOR)
2121

22-
1. When receiving a new ontology request (NOR), the NOR Manager should thank the submitter for their submission.
23-
2. The OBO dashboard administrator adds the new submission to the NOR dashboard, which is deployed at https://obofoundry.github.io/obo-nor.github.io/
24-
3. After the dashboard is run, the OBO dashboard administrator informs the submitter about the need to fix the issues revealed by the dashboard, noting this is not part of the review itself, just a precursor, and that upon completion, a liaison will be assigned.
25-
4. At the next OBO Foundry Operations Committee conference call (hereafter, "Operations call"), a liaison is selected to be responsible for the issue. This liaison becomes familiar with the new ontology and rallies the appropriate people to provide feedback.
26-
5. At the next Operations call after that one, the liaison presents the NOR to the OBO Foundry Operations Committee and answers questions. In most cases, the information provided will be sufficient to either grant or refuse the prefix request. In some cases, the committee may choose to postpone its decision to require some clarification and fixes from the submitter.
27-
The liaison MUST be present at the Operations call in order for the NOR case to be discussed. If the liaison does not participate for 2 consecutive Operations calls, the chair of the second call emails the liaison to request a statement confirming the ability to continue as liaison. If the liaison does not participate in 3 consecutive Operations calls and did not respond to the email above, a new liaison is assigned during that third call.
22+
1. When receiving a new ontology request (NOR), the NOR Manager should thank the submitter for their submission. In addition, the NOR Manager should assist NOR submitters in understanding the NOR process and passing the NOR review during the whole process.
23+
2. The NOR Manager adds the new submission to the NOR dashboard, which is deployed at https://obofoundry.github.io/obo-nor.github.io/
24+
3. In addition to the dashboard, the NOR Manager could need to manually review that the submitted ontology adheres to the OBO foundry [principles](http://obofoundry.org/principles/fp-000-summary.html). For example, IRIs and object properties need to be reviewed manually pending the implementation of new automated checks.
25+
4. After the dashboard is run and the manual review is done, the NOR Manager informs the OBO Foundry Operations Committee of any issues for consideration. Until all issues are resolved or the NOR request is rejected, the NOR Manager acts as a liaison between the OBO Foundry Operations Committee and the NOR submitter.
26+
5. Once the new ontology passes the review, the NOR manager assigns the next available reviewer from the OBO operation members.
27+
6. Finally, when the ontology is fully accepted, the NOR manager remove the ontology from the OBO NOR dashboard.
28+
29+
New Ontology Requests SOP are fully documented [here](/roles/nor-manager).
30+
2831

2932
<a name="ROOM"></a>
3033
### Reviewing Ontologies for OBO Membership

docs/roles/RoleNORManager.md

Lines changed: 48 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -12,42 +12,47 @@ The New Ontology Request (NOR) Manager has these basic duties:
1212
4. Assigning a provisional reviewer from the OBO Operations Committee
1313
5. Removing the accepted ontology from the NOR Dashboard upon acceptance
1414

15-
1615
### Receiving `new ontology` requests on OBO and acknowledging the receipt
1716

1817
- The NOR Manager MUST actively listen to issues on the [OBOFoundry GitHub issues tracker](https://github.com/OBOFoundry/OBOFoundry.github.io/issues).
18+
1919
- 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:
20-
```markdown
21-
Dear @GITHUBNAME,
22-
23-
Thank you for your submission.
24-
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).
25-
Thank you.
26-
```
20+
21+
```markdown
22+
Dear @GITHUBNAME,
23+
24+
Thank you for your submission.
25+
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).
26+
Thank you.
27+
```
28+
2729
- When a valid NOR request is received the NOR Manager acknowledges the receipt with the following message:
28-
```markdown
29-
Dear @GITHUBNAME,
30-
31-
Thank you for your submission. The review will be executed as a two stage process.
32-
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_.
33-
After you have successfully passed the Dashboard you will be assigned an OBO Operations committee member to review the ontology.
34-
35-
Usually, the review will result in an opportunity for you to improve the ontology.
36-
When the reviewer believes the ontology is ready for presentation to the OBO Operations Committee, they will present
37-
your ontology during an OBO Operations Call. This gives other members of the
38-
committee the opportunity to assess your work.
39-
40-
When a decision is reached by the committee you will be informed here on the issue tracker.
41-
The process can take any number of weeks or months, depending on the case at hand.
42-
Please inform us about any reasons you might have for increased urgency.
43-
44-
You will be informed once your ontology is loaded in the OBO NOR Dashboard.
45-
46-
Good luck.
47-
```
30+
31+
```markdown
32+
Dear @GITHUBNAME,
33+
34+
Thank you for your submission. The review will be executed as a two stage process.
35+
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_.
36+
After you have successfully passed the Dashboard you will be assigned an OBO Operations committee member to review the ontology.
37+
38+
Usually, the review will result in an opportunity for you to improve the ontology.
39+
When the reviewer believes the ontology is ready for presentation to the OBO Operations Committee, they will present
40+
your ontology during an OBO Operations Call. This gives other members of the
41+
committee the opportunity to assess your work.
42+
43+
When a decision is reached by the committee you will be informed here on the issue tracker.
44+
The process can take any number of weeks or months, depending on the case at hand.
45+
Please inform us about any reasons you might have for increased urgency.
46+
47+
You will be informed once your ontology is loaded in the OBO NOR Dashboard.
48+
49+
Good luck.
50+
```
51+
4852
- The NOR Manager must ensure that the requestors use the proper communication channels with the OBO community:
49-
- Make sure that the requestors have joined and send an appropriate email to the obo-discuss mailing list (see the [FAQ](https://obofoundry.org/faq/how-do-i-register-my-ontology.html)). If they have not, point them to the instructions and ask them to do so.
50-
- Invite the requestors (using the email listed in the metadata) to the OBO Foundry Slack space (using the `Slack->Invite people to obo-community` menu, adding the email provided.
53+
54+
- Make sure that the requestors have joined and send an appropriate email to the obo-discuss mailing list (see the [FAQ](https://obofoundry.org/faq/how-do-i-register-my-ontology.html)). If they have not, point them to the instructions and ask them to do so.
55+
- Invite the requestors (using the email listed in the metadata) to the OBO Foundry Slack space (using the `Slack->Invite people to obo-community` menu, adding the email provided.
5156

5257
### Including the ontology into the OBO New Ontology Request (NOR) Dashboard and updating the dashboard
5358

@@ -56,10 +61,12 @@ The OBO NOR Dashboard is managed here: https://github.com/OBOFoundry/obo-nor.git
5661
Integrating the submitted ontology into OBO dashboard means simply adding a new record into the `ontologies->custom` subsection
5762
of the [dashboard config file](https://github.com/OBOFoundry/obo-nor.github.io/blob/master/dashboard-config.yml). Only information explicitly mentioned in the New Ontology Request should be used.
5863
NOTE:
64+
5965
> **All modifications on obo-nor.github.io repository MUST be done via pull requests and NOT via direct commits on the master branch.
6066
> The /workflow/dahsboard.yml file must indicate the GitHubID of the actual NOR manager as assignee.**
6167
6268
Every update (adding or removing an ontology) should proceed as follows:
69+
6370
1. Creation of a Pull Request (PR) for modification of the [dashboard config file](https://github.com/OBOFoundry/obo-nor.github.io/blob/master/dashboard-config.yml) for adding or deleting record in the `ontologies->custom` section of the file.
6471
2. Once the previous PR is merged, it triggers the *Update dashboard run* [GitHub action](https://github.com/OBOFoundry/obo-nor.github.io/blob/master/.github/workflows/dashboard.yml). This action can also be triggered manually [here](https://github.com/OBOFoundry/obo-nor.github.io/actions/workflows/dashboard.yml) with the `run workflow` button.
6572
3. Once the run is complete, a new PR named `Update dashboard run` is created. Manually check the diff, especially the /dashboard/dahsboard-result.yml file for inconsistencies.
@@ -70,7 +77,17 @@ In addition, the *Update dashboard run* action is automatically triggered on Mon
7077
### Supporting the New Ontology requestor to pass the OBO Dashboard
7178

7279
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](https://obofoundry.org/principles/fp-000-summary.html) may be necessary.
73-
- All discussions between the requestors and the NOR manager must take place in the [OBO Issue Tracker](https://github.com/OBOFoundry/OBOFoundry.github.io/issues) in the NOR issue created by the requestor.
80+
81+
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:
82+
83+
- URIs: check if it includes "https" and if it [conforms with the overall format](http://obofoundry.org/id-policy) "http://purl.obolibrary.org/obo/ONTOLOGY_"
84+
85+
86+
- 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**.
87+
88+
- Imports: Ensure that there is a mechanism in place to update imported terms (classes and properties).
89+
90+
During this process, all discussions between the requestors and the NOR manager must take place in the [OBO Issue Tracker](https://github.com/OBOFoundry/OBOFoundry.github.io/issues) in the NOR issue created by the requestor.
7491

7592
### Assigning a provisional reviewer from the OBO Operations Committee
7693

0 commit comments

Comments
 (0)