Skip to content

Commit 45e831e

Browse files
committed
docs: enhance documentation for ROR support in institution and project creation
1 parent 6a1ab05 commit 45e831e

File tree

5 files changed

+25
-4
lines changed

5 files changed

+25
-4
lines changed

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

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,24 @@ To create a profile, choose Profile from the Create menu at the top of the page.
2323
To create an Institution, choose Institution from the Create menu at the top of the page.
2424

2525
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.
26+
You can also add a department to an institution.
27+
28+
Institutions can also be linked to the [Research Organization Registry (ROR)](https://ror.org/).
29+
30+
Three Ways to Add Institutions:
31+
32+
1. **Use the name search field when creating a new institution.**
33+
Search for the organization and select the correct match to automatically populate its basic details and store its ROR identifier.
34+
35+
![Institution name search](images/user-guide/ror/ror_institution_name.png)
36+
37+
38+
2. **Enter a known ROR ID directly.**
39+
If you already know the institution’s ROR ID, you can enter it to automatically retrieve and fill in the associated details.
40+
41+
![Institution id search](images/user-guide/ror/ror_institution_id.png)
42+
43+
44+
3. **Add an institution without a ROR entry.**
45+
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.
2646

27-
Institutions can also be linked to the [Research Organization Registry (ROR)](https://ror.org/). Use the ROR search box to look up the organization while creating it and select the correct entry to automatically populate the basic details and store the ROR identifier. If you already know the ROR identifier you can enter it directly. When the organization is not listed in ROR you can leave the field blank and continue with the standard manual fields.

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

Lines changed: 5 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,9 +49,11 @@ 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-
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 auto-populate the organization details and capture the ROR identifier. If you already know the identifier you can add it directly. When the organization is not listed in ROR you can leave the field empty and continue manually.
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.
5353

54-
![Define Institution]({{ "/images/user-guide/create-project-define-institution.png" | relative_url }}){:.screenshot}
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)
5557

5658
### Approval step
5759

221 KB
Loading
277 KB
Loading
330 KB
Loading

0 commit comments

Comments
 (0)