From a71bc1d24ebe289f6fbbd8f0171da6ecede7b450 Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Thu, 22 Feb 2024 14:39:14 -0600 Subject: [PATCH 1/6] Add `Create a DANDI Account` page --- docs/13_upload.md | 12 +----------- docs/16_account.md | 13 +++++++++++++ docs/50_hub.md | 1 + mkdocs.yml | 1 + 4 files changed, 16 insertions(+), 11 deletions(-) create mode 100644 docs/16_account.md diff --git a/docs/13_upload.md b/docs/13_upload.md index cdafa31e..2d48d174 100644 --- a/docs/13_upload.md +++ b/docs/13_upload.md @@ -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 [http://dandiarchive.org](http://dandiarchive.org). This Dandiset can be fully @@ -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 [Create a DANDI Account](./16_account.md). 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. diff --git a/docs/16_account.md b/docs/16_account.md new file mode 100644 index 00000000..79b751da --- /dev/null +++ b/docs/16_account.md @@ -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 activation of your account within 24 +hours, after which you can log in to DANDI using GitHub by clicking the +`LOG IN WITH GITHUB` button. \ No newline at end of file diff --git a/docs/50_hub.md b/docs/50_hub.md index 4a523f5f..17b9a32f 100644 --- a/docs/50_hub.md +++ b/docs/50_hub.md @@ -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 [Create a DANDI Account](./16_account.md). ## Choosing a server option diff --git a/mkdocs.yml b/mkdocs.yml index 10211565..8ba59a91 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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" From c4ef796b376dc0403389ceefbaa8d9d89b45909f Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Thu, 22 Feb 2024 14:42:08 -0600 Subject: [PATCH 2/6] Update text --- docs/13_upload.md | 2 +- docs/50_hub.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/13_upload.md b/docs/13_upload.md index 2d48d174..62cdafe3 100644 --- a/docs/13_upload.md +++ b/docs/13_upload.md @@ -19,7 +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 [Create a DANDI Account](./16_account.md). +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. diff --git a/docs/50_hub.md b/docs/50_hub.md index 17b9a32f..b817ec94 100644 --- a/docs/50_hub.md +++ b/docs/50_hub.md @@ -7,7 +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 [Create a DANDI Account](./16_account.md). +See the [Create a DANDI Account](./16_account.md) page. ## Choosing a server option From 9f0d2ca3a099eff5d2a1223a9ac99b24b08235be Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Fri, 23 Feb 2024 16:20:52 -0600 Subject: [PATCH 3/6] Update docs/16_account.md Co-authored-by: Yaroslav Halchenko --- docs/16_account.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/16_account.md b/docs/16_account.md index 79b751da..f5b2bd8c 100644 --- a/docs/16_account.md +++ b/docs/16_account.md @@ -8,6 +8,6 @@ With a DANDI account, you can additionally create Dandisets and access the DANDI 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 activation of your account within 24 -hours, after which you can log in to DANDI using GitHub by clicking the -`LOG IN WITH GITHUB` button. \ No newline at end of file +1. You will receive an email acknowledging that your request for an account will be reviewed within 24 hours: + - **note**: requests from a new GitHub accounts and from emails not withing `.edu` domain might take longer to review and 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 approved, you would be able to log in to DANDI using GitHub by clicking the `LOG IN WITH GITHUB` button. \ No newline at end of file From d3bb3b6dbcbda2f49f9a6687989883b95f2fb472 Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Fri, 23 Feb 2024 16:21:16 -0600 Subject: [PATCH 4/6] Update docs/16_account.md --- docs/16_account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/16_account.md b/docs/16_account.md index f5b2bd8c..73c6a910 100644 --- a/docs/16_account.md +++ b/docs/16_account.md @@ -8,6 +8,6 @@ With a DANDI account, you can additionally create Dandisets and access the DANDI 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: +1. You will receive an email acknowledging that your request for an account will be reviewed within 24 hours. - **note**: requests from a new GitHub accounts and from emails not withing `.edu` domain might take longer to review and 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 approved, you would be able to log in to DANDI using GitHub by clicking the `LOG IN WITH GITHUB` button. \ No newline at end of file From 294ee22179aa5b30e96c974edd53faffc1bef463 Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Fri, 23 Feb 2024 16:22:12 -0600 Subject: [PATCH 5/6] Update docs/16_account.md --- docs/16_account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/16_account.md b/docs/16_account.md index 73c6a910..13a57d5c 100644 --- a/docs/16_account.md +++ b/docs/16_account.md @@ -10,4 +10,4 @@ With a DANDI account, you can additionally create Dandisets and access the DANDI 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 a new GitHub accounts and from emails not withing `.edu` domain might take longer to review and 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 approved, you would be able to log in to DANDI using GitHub by clicking the `LOG IN WITH GITHUB` button. \ No newline at end of file +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. \ No newline at end of file From 4e29b82f0711a2362d68e47ba6eccc9728ba9aa2 Mon Sep 17 00:00:00 2001 From: Kabilar Gunalan Date: Fri, 23 Feb 2024 16:32:50 -0600 Subject: [PATCH 6/6] Update docs/16_account.md --- docs/16_account.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/16_account.md b/docs/16_account.md index 13a57d5c..61aac25d 100644 --- a/docs/16_account.md +++ b/docs/16_account.md @@ -9,5 +9,5 @@ With a DANDI account, you can additionally create Dandisets and access the DANDI 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 a new GitHub accounts and from emails not withing `.edu` domain might take longer to review and more likely to be rejected, especially if there are no plans described to upload data to the archive + - **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. \ No newline at end of file