Merge pull request #773 from NeurodataWithoutBorders/dandi-upload-cha…

…nges Improve DANDI upload documentation
NeurodataWithoutBorders · May 6, 2024 · 69fbddf · 69fbddf
2 parents c501319 + b907f7e
commit 69fbddf
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 17 deletions.
diff --git a/docs/tutorials/dataset_publication.rst b/docs/tutorials/dataset_publication.rst
@@ -1,5 +1,5 @@
 Dataset Publication
-=======================================
+===================
 
 For this tutorial, we'll be adapting the previous :doc:`Multi-Session Tutorial </tutorials/multiple_sessions>` to publish our data to the DANDI Archive.
 
@@ -43,24 +43,21 @@ To get your API key, visit the :dandi-staging:`staging website <>` and click on
   :align: center
   :alt: DANDI staging API key added
 
-Submit this to the Staging API Key input on the GUIDE.
+Provide this for the Staging API Key value on the GUIDE.
 
 .. figure:: ../assets/tutorials/dandi/api-token-added.png
   :align: center
   :alt: DANDI staging API key added
 
+Press the **Submit** button to save your API key. This will populate the **Dandiset** input with a list of Dandisets associated with your account, which you can search by title or ID.
 
-Once you have specified your Staging API Key, the **Dandiset** input will allow you to select any existing Dandiset associated with your account by ID (e.g., "207698") or name (e.g., "NWB GUIDE Test").
+But what if you don't have any Dandisets to upload to? No problem!
 
-Continue to the next page to trigger your upload to the DANDI Archive.
+Creating a Dandiset
+^^^^^^^^^^^^^^^^^^^
+If you don't already have a Dandiset on the Staging server, you can create one directly from the GUIDE.
 
-.. figure:: ../assets/tutorials/dandi/dandiset-id.png
-  :align: center
-  :alt: DANDI upload page with Dandiset ID specified
-
-Creating a Dandiset from the GUIDE
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-If you do not already own a Dandiset on staging, you will need to create one. Press the Create New Dandiset button to open a pop-up that guides you through the required fields for Dandiset creation.
+Press the **Create New Dandiset** button to open a pop-up that guides you through the required fields for Dandiset creation.
 
 .. figure:: ../assets/tutorials/dandi/create-dandiset.png
   :align: center
@@ -69,6 +66,15 @@ If you do not already own a Dandiset on staging, you will need to create one. Pr
 
 Once this pop-up form is submitted, the Dandiset input will now contain your new Dandiset.
 
+
+.. figure:: ../assets/tutorials/dandi/dandiset-id.png
+  :align: center
+  :alt: DANDI upload page with Dandiset ID specified
+
+
+
+Finally, press the **Upload** button to begin the upload process.
+
 Final Review
 ------------
 Once your upload to the DANDI Archive is complete, you will be able to review a quick overview of the associated Dandiset and a list of the uploaded files from this pipeline.

diff --git a/schemas/dandi-upload.schema.ts b/schemas/dandi-upload.schema.ts
@@ -100,7 +100,7 @@ export const addDandiset = async (info) => {
     const enumLabels = `${id} — ${latestVersionInfo.name}`
 
     const isDraft = latestVersionInfo.version === 'draft'
-    const enumCategories = (isDraft ? 'Unpublished' : '') + (staging ? ' - Staging' : '')
+    const enumCategories = (isDraft ? 'Unpublished' : '') + (staging ? `${isDraft ? ` - ` : ''}Staging` : '')
 
     const fullInfo = await info.getInfo({ version: latestVersionInfo.version });
 

diff --git a/schemas/json/dandi/upload.json b/schemas/json/dandi/upload.json
@@ -2,7 +2,7 @@
     "properties": {
         "dandiset": {
             "type": "string",
-            "description": "The unique identifier for your Dandiset. Can also be created or searched by name."
+            "description": "The title of the Dandiset to upload to. Can also provide the Dandiset ID.<br><small><b>Example:</b> My Dandiset or <code>207698</code></small>"
         },
         "additional_settings": {
             "properties": {

diff --git a/src/renderer/src/pages.js b/src/renderer/src/pages.js
@@ -148,7 +148,7 @@ const pages = {
             }),
 
             upload: new GuidedUploadPage({
-                title: "DANDI Upload Options",
+                title: "DANDI Upload",
                 label: "Upload to DANDI",
                 section: sections[3],
                 sync: ["conversion"],

diff --git a/src/renderer/src/stories/Search.js b/src/renderer/src/stories/Search.js
@@ -172,7 +172,7 @@ export class Search extends LitElement {
             }
 
             .category {
-                padding: 10px 25px;
+                padding: 10px 18px;
                 background: gainsboro;
                 border-top: 1px solid gray;
                 border-bottom: 1px solid gray;

diff --git a/src/renderer/src/stories/forms/GlobalFormModal.ts b/src/renderer/src/stories/forms/GlobalFormModal.ts
@@ -82,7 +82,7 @@ export function createFormModal ({
     content.style.padding = "25px"
 
     const saveButton = new Button({
-        label: "Update",
+        label: "Submit",
         primary: true,
         onClick: async () => {
             await globalForm.validate()

diff --git a/src/renderer/src/stories/pages/guided-mode/options/GuidedUpload.js b/src/renderer/src/stories/pages/guided-mode/options/GuidedUpload.js
@@ -35,7 +35,7 @@ export class GuidedUploadPage extends Page {
     };
 
     header = {
-        subtitle: "Settings to upload your conversion to the DANDI Archive",
+        subtitle: "Configure your upload to the DANDI Archive",
         controls: [
             new Button({
                 icon: keyIcon,