Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add ORCID login documentation and email setup steps #3180

Merged
merged 6 commits into from
Oct 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/assets/orcid/step-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/orcid/step-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/orcid/step-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
'user-guide',
'api',
'git',
'orcid',
'monitoring', # Still rendered, but not in ToC
'maintenance',
)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
19 changes: 19 additions & 0 deletions docs/orcid.md
Original file line number Diff line number Diff line change
@@ -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)
Loading