Skip to content

Commit

Permalink
Merge pull request #116 from kabilar/create-account
Browse files Browse the repository at this point in the history
Add a `Create a DANDI Account` page
  • Loading branch information
yarikoptic authored Mar 27, 2024
2 parents e8feeb8 + 4e29b82 commit 6624c05
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 11 deletions.
12 changes: 1 addition & 11 deletions docs/13_upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,6 @@

To create a new Dandiset and upload your data, you need to have a DANDI account.

## Create an Account on DANDI

To create a DANDI account:

1. [Create a GitHub account](https://github.com/) if you don't have one.
2. Using your GitHub account, [register a DANDI account](https://gui.dandiarchive.org/#/user/register).

You will receive an email acknowledging activation of your account within 24
hours, after which you can log in to DANDI using GitHub by clicking the login
button.

## Create a Dandiset and Add Data

You can create a new Dandiset at https://dandiarchive.org. This Dandiset can be fully
Expand All @@ -30,6 +19,7 @@ two different servers differ slightly.

### **Setup**

1. To create a new Dandiset and upload your data, you need to have a DANDI account. See the [Create a DANDI Account](./16_account.md) page.
1. Log in to DANDI and copy your API key. Click on your user initials in the
top-right corner after logging in. Production (dandiarchive.org) and staging (gui-staging.dandiarchive.org) servers
have different API keys and different logins.
Expand Down
13 changes: 13 additions & 0 deletions docs/16_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Create a DANDI Account

A DANDI account is only required for specific features.
Without a DANDI account, you can search, view, and download files.
With a DANDI account, you can additionally create Dandisets and access the DANDI Hub to analyze existing data.

## Instructions

1. To create a DANDI account, first [create a GitHub account](https://github.com/) if you don't have one.
1. Using your GitHub account, register for a DANDI account by selecting the `LOG IN WITH GITHUB` button on the [DANDI homepage](https://dandiarchive.org).
1. You will receive an email acknowledging that your request for an account will be reviewed within 24 hours.
- **note**: Requests from new GitHub accounts and from emails that are not an `.edu` domain might take longer to review and are more likely to be rejected, especially if there are no plans described to upload data to the archive.
1. If your request for an account is approved, you will be able to log in to DANDI using GitHub by clicking the `LOG IN WITH GITHUB` button.
1 change: 1 addition & 0 deletions docs/50_hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Note that DANDI Hub is not intended for significant computation, but provides a
## Registration

To use the [DANDI Hub](http://hub.dandiarchive.org), you must first register for an account using the [DANDI website](http://dandiarchive.org).
See the [Create a DANDI Account](./16_account.md) page.

## Choosing a server option

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ nav:
- Data Licenses: "35_data_licenses.md"
- User Guide:
- Using DANDI: "10_using_dandi.md"
- Create DANDI Account: "16_account.md"
- Viewing Dandisets: "11_view.md"
- Downloading Data and Dandisets: "12_download.md"
- Creating Dandisets and Uploading Data: "13_upload.md"
Expand Down

0 comments on commit 6624c05

Please sign in to comment.