Skip to content

Commit 46749e2

Browse files
authored
Merge pull request #72 from seek4science/copilot/add-documentation-for-ror-support
Document ROR lookup support when creating institutions and projects
2 parents 91cfed4 + 497f15f commit 46749e2

File tree

5 files changed

+36
-8
lines changed

5 files changed

+36
-8
lines changed

help/user-guide/adding-admin-items.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,49 @@
22
title: Adding admin items
33
---
44

5-
These are items that cannot be created by a general user, but can be created by a SEEK administrator, [Project Administrator](roles#project-administrator), or [Programme Administrator](roles.html#programme-administrator)
5+
These are items that cannot be created by a general user, but can be created by a {{ site.seek_instance.name | default: "FAIRDOM-SEEK" }} administrator, [Project Administrator](roles#project-administrator), or [Programme Administrator](roles.html#programme-administrator)
66

77
## Creating organisms
88

99
To create an organism, choose Organism from the Create menu at the top of the page.
1010

1111
An Organism can just have a title, but preferably also include the NCBI taxonomy URI. To make this easier there is an option to search for the organism, and then click the result to automatically add the name and taxonomy URI.
1212

13-
*Note, if you are running your own installation of SEEK, the search is only available if you have [registered with BioPortal](https://bioportal.bioontology.org/accounts/new) and created an API key. The API key needs to be set under the Server Admin area - under Site configuration, Additional settings.*
13+
{% include callout.html type="note" content="
14+
If you are running your own installation of FAIRDOM-SEEK, the search is only available if you have [registered with BioPortal](https://bioportal.bioontology.org/accounts/new) and created an API key. The API key needs to be set under the Server Admin area - under Site configuration, Additional settings.
15+
" %}
1416

1517
## Creating profiles
1618

17-
It is possible to create profiles for people that have not registered with SEEK. This is useful if you want to describe and credit members of your Project who are not yet SEEK users. They can adopt their profile later during [Registering](registering).
19+
It is possible to create profiles for people that have not registered with {{ site.seek_instance.name | default: "SEEK" }}. This is useful if you want to describe and credit members of your Project who are not yet {{ site.seek_instance.name | default: "SEEK" }} users. They can adopt their profile later during [Registering](registering).
1820

19-
To create a profile, choose Profile from the Create menu at the top of the page. The first and last name are required, and also the email address. The email address must be unique to SEEK.
21+
To create a profile, choose Profile from the Create menu at the top of the page. The first and last name are required, and also the email address. The email address must be unique to {{ site.seek_instance.name | default: "SEEK" }}.
2022

2123
## Creating institutions
2224

2325
To create an Institution, choose Institution from the Create menu at the top of the page.
2426

25-
The title and country are required, and the title must be unique to SEEK. It is recommended that you provide as much detail as you can. Once created you can also provide a logo or picture by clicking change picture under the picture on the right of the Institution page.
27+
The title and country are required, and the title must be unique to {{ site.seek_instance.name | default: "SEEK" }}. It is recommended that you provide as much detail as you can. Once created you can also provide a logo or picture by clicking Change Picture under the picture on the right of the Institution page.
28+
You can also add a department to an institution.
29+
30+
### Linking an institution to the Research Organization Registry (ROR)
31+
32+
Institutions can also be linked to the [Research Organization Registry (ROR)](https://ror.org/). ROR is a global, community-led registry of open persistent identifiers for research and funding organizations. If you include the ROR for an institution in SEEK, it will improve research tracking, boost interoperability, and enable better collaboration, making it clear which university, lab, or funder is involved in research, essential for publishers, repositories, and funders to connect researchers to their work accurately.
33+
34+
There are three ways to add an institution or ROR in {{ site.seek_instance.name | default: "SEEK" }}:
35+
36+
One. **Use the name search field when creating a new institution.**
37+
Search for the organization and select the correct match to automatically populate its basic details and store its ROR identifier.
38+
39+
![Institution name search]({{ "/images/user-guide/ror/ror_institution_name.png" | relative_url }}){:.screenshot}
40+
41+
42+
Two. **Enter a known ROR ID directly.**
43+
If you already know the institution’s ROR ID, you can enter it to automatically retrieve and fill in the associated details.
44+
45+
![Institution id search]({{ "/images/user-guide/ror/ror_institution_id.png" | relative_url }}){:.screenshot}
46+
47+
48+
Three. **Add an institution without a ROR entry.**
49+
If the organization does not appear in ROR (and therefore has no ROR ID), simply leave the ROR field blank and complete the standard manual fields.
50+

help/user-guide/create-a-project.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You next need to define the Project. At a minimum a title is required, but you c
4040

4141
![Define Project]({{ "/images/user-guide/create-project-define-project.png" | relative_url }}){:.screenshot}
4242

43-
## Defining your Institution
43+
### Defining your Institution
4444

4545
When the Project is created, you will automatically become a member along with its administrator.
4646
To become a member you also have to describe the institution (or affiliation) that you are associated with in relation to this Project. It doesn't have to be the same Institution as other Projects, and it is not unusual for it to be different.
@@ -49,11 +49,14 @@ Start to type the name of your institution, and existing options will be display
4949

5050
If describing a new Institution only the title is required, but you can also provide details about its website, city and country. You will also be able to edit and add additional information afterwards.
5151

52-
![Define Institution]({{ "/images/user-guide/create-project-define-institution.png" | relative_url }}){:.screenshot}
52+
There is also support for the [Research Organization Registry (ROR)](https://ror.org/). Use the ROR search field to find your institution and select the matching entry to automatically populate the organization details and capture the ROR identifier. If you already know the identifier, you can enter it directly. When the organization is not listed in ROR, you can leave the field empty and continue manually.
53+
54+
If the institution you searched for already exists locally, it will appear under **Institutions saved locally**. Otherwise, it will be listed as a new **institutions fetched from ROR**.
55+
56+
![define_institution]({{ "/images/user-guide/ror/ror_project.png" | relative_url }}){:.screenshot}
5357

5458
### Approval step
5559

5660
If you are creating a Project within a Programme you administer, then there is no approval step. You will be shown a page to review the details and then create straight away.
5761

5862
Otherwise, an appropriate administrator will be notified by email about your request. They will also be notified directly when using {{ site.seek_instance.name | default: "FAIRDOM-SEEK" }}. The administrator will be shown a page that allows them to quickly review the details and either accept or reject the request, and in either case you will be notified by email.
59-
221 KB
Loading
277 KB
Loading
330 KB
Loading

0 commit comments

Comments
 (0)