diff --git a/docs/assets/orcid/step-1.png b/docs/assets/orcid/step-1.png new file mode 100644 index 000000000..357ce383a Binary files /dev/null and b/docs/assets/orcid/step-1.png differ diff --git a/docs/assets/orcid/step-2.png b/docs/assets/orcid/step-2.png new file mode 100644 index 000000000..a35418704 Binary files /dev/null and b/docs/assets/orcid/step-2.png differ diff --git a/docs/assets/orcid/step-3.png b/docs/assets/orcid/step-3.png new file mode 100644 index 000000000..a3c0c36b6 Binary files /dev/null and b/docs/assets/orcid/step-3.png differ diff --git a/docs/conf.py b/docs/conf.py index 3a8a92390..057136bfc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,6 +47,7 @@ 'user-guide', 'api', 'git', + 'orcid', 'monitoring', # Still rendered, but not in ToC 'maintenance', ) diff --git a/docs/index.md b/docs/index.md index c80fc98a0..16d778b69 100644 --- a/docs/index.md +++ b/docs/index.md @@ -47,6 +47,7 @@ Finally, if you'd like to suggest a new feature for OpenNeuro, you can do so at user_guide faq +orcid ``` ```{toctree} diff --git a/docs/orcid.md b/docs/orcid.md new file mode 100644 index 000000000..38ceae72b --- /dev/null +++ b/docs/orcid.md @@ -0,0 +1,19 @@ +# ORCID Logins + +OpenNeuro supports account creation with [ORCID](https://orcid.org/). Creating an ORCID iD allows you to login to OpenNeuro, associate works with your profile, and gives OpenNeuro users interacting with datasets a mechanism to contact you or source your activity on OpenNeuro (datasets, comments, etc). OpenNeuro also displays your published name or given name on datasets you have uploaded or modified, and comments. In the future, related datasets discoverable via ORCID may be shown using your ORCID iD and name. + +## Enabling Trusted Access to Emails + +To use all features of OpenNeuro, you must make at least one email address available to OpenNeuro from your ORCID profile. The first email visible to OpenNeuro will be used for email notifications on your dataset and allows other users to grant you permissions on their datasets by entering this email address. OpenNeuro requires a minimum of trusted institutional access. + +Visit [your ORCID profile](https://orcid.org/my-orcid) and add or modify an email. + +![ORCID profile emails list on left side of profile](./assets/orcid/step-1.png) + +Ensure that at least one email address is visible to everyone or trusted parties, and has been verified with ORCID. + +![Example of setting an email to trusted parties](./assets/orcid/step-2.png) + +Sign out and reauthenticate with OpenNeuro to update your OpenNeuro account after any email changes on your ORCID profile. + +![Log out button shown at bottom of user menu](./assets/orcid/step-3.png) \ No newline at end of file