You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer_guide.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -246,7 +246,7 @@ Updating Tutorial Screenshots
246
246
Before a release, you'll want to update the tutorial screenshots to reflect the latest changes in the application.
247
247
248
248
#. To regenerate the dataset, you'll need to change ``regenerateTestData`` in the ``tests/e2e/config.ts`` to ``true`` or delete the test dataset directory ``rm -rf ~/NWB_GUIDE/.test``.
249
-
#. Create a ``.env`` file with the following content: ``DANDI_STAGING_API_KEY={your_dandi_staging_api_key}`` where ``{your_dandi_staging_api_key}`` is your DANDI staging API key from https://gui-staging.dandiarchive.org.
249
+
#. Create a ``.env`` file with the following content: ``DANDI_STAGING_API_KEY={your_dandi_sandbox_api_key}`` where ``{your_dandi_sandbox_api_key}`` is your DANDI sandbox API key from https://gui-sandbox.dandiarchive.org.
250
250
#. Run the End-to-End Tests locally using ``npm run test:tutorial``. This will generate new screenshots in the ``docs/assets/tutorials`` directory.
251
251
#. Review the new screenshots to ensure they are accurate.
252
252
#. If the screenshots are accurate, commit them to the repository. Their paths should be consistent across runs—allowing the new versions to show up on the tutorial.
Copy file name to clipboardExpand all lines: docs/tutorials/dataset_publication.rst
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@ Dataset Publication
4
4
For this tutorial, we'll publish the NWB files created in :doc:`Multi-Session Tutorial </tutorials/multiple_sessions>` as a Dandiset on the DANDI Archive. This workflow works for any collection of NWB files (2.1+), whether they were created by NWB GUIDE or not.
5
5
6
6
.. note::
7
-
Creating an account on DANDI requires approval from the archive administrators. Separate approval is required for both the main archive and the development server.
7
+
Creating an account on DANDI requires approval from the archive administrators. Separate approval is required for both the main archive and the sandbox server.
8
8
9
-
**This tutorial requires an account on the** :dandi-staging:`DANDI Development server <>`. You’ll want to publish your `real` data on the main archive, which will require a separate approval but otherwise follows the same workflow defined in this tutorial.
9
+
**This tutorial requires an account on the** :dandi-sandbox:`DANDI Sandbox server <>`. You’ll want to publish your `real` data on the main archive, which will require a separate approval but otherwise follows the same workflow defined in this tutorial.
10
10
11
11
Once your account is approved, you can move on to the next steps.
12
12
@@ -24,31 +24,31 @@ You'll now notice that the **Exit Pipeline** button has been replaced with **Nex
24
24
25
25
DANDI Upload
26
26
------------
27
-
You’ll need to specify your DANDI API keys if you haven’t uploaded from the GUIDE before. These keys are unique between the Main and Development servers.
27
+
You’ll need to specify your DANDI API keys if you haven’t uploaded from the GUIDE before. These keys are unique between the Main and Sandbox servers.
To get your API key, visit the :dandi-staging:`staging website <>` and click on the profile icon in the top-right corner. This will show a dropdown with a copy button, which will assign your API key to the clipboard.
33
+
To get your API key, visit the :dandi-sandbox:`sandbox website <>` and click on the profile icon in the top-right corner. This will show a dropdown with a copy button, which will assign your API key to the clipboard.
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.
46
46
47
47
But what if you don't have any Dandisets to upload to? No problem!
48
48
49
49
Creating a Dandiset
50
50
^^^^^^^^^^^^^^^^^^^
51
-
If you don't already have a Dandiset on the Development server, you can create one directly from the GUIDE.
51
+
If you don't already have a Dandiset on the Sandbox server, you can create one directly from the GUIDE.
52
52
53
53
Press the **Create New Dandiset** button to open a pop-up that guides you through the required fields for Dandiset creation.
Copy file name to clipboardExpand all lines: docs/tutorials/index.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,17 @@ In these tutorials, you'll follow along on a :doc:`local installation of the GUI
9
9
Watch a video walkthrough of these tutorials `here <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.
10
10
11
11
.. note::
12
-
This tutorial focuses on uploading to the DANDI Development server.
12
+
This tutorial focuses on uploading to the DANDI Sandbox server.
13
13
14
-
**When working with real data, you'll want to publish to the Main Archive**. In this case, follow the same steps outlined here—except replace the Development server with the Main Archive.
14
+
**When working with real data, you'll want to publish to the Main Archive**. In this case, follow the same steps outlined here—except replace the Sandbox server with the Main Archive.
15
15
16
16
.. note::
17
17
18
-
If you intend to complete the Dataset Publication section of this tutorial, you'll need to create an account on the DANDI Archive. This will need to be approved by the archive administrators and will require separate approval for both the main archive and the development server.
18
+
If you intend to complete the Dataset Publication section of this tutorial, you'll need to create an account on the DANDI Archive. This will need to be approved by the archive administrators and will require separate approval for both the main archive and the sandbox server.
19
19
20
-
**This tutorial requires an account on the** :dandi-staging:`DANDI Development server <>`.
20
+
**This tutorial requires an account on the** :dandi-sandbox:`DANDI Sandbox server <>`.
21
21
22
-
We recommend that you create an account on the Development server before you begin the tutorials.
22
+
We recommend that you create an account on the Sandbox server before you begin the tutorials.
23
23
24
24
Before you begin these tutorials, **you'll need to generate the tutorial dataset** using the instructions on the Dataset page.
0 commit comments