Skip to content

Commit 70accc0

Browse files
Copilotbendichter
andcommitted
Update documentation references from staging to sandbox
Co-authored-by: bendichter <[email protected]>
1 parent fee110c commit 70accc0

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

docs/developer_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ Updating Tutorial Screenshots
246246
Before a release, you'll want to update the tutorial screenshots to reflect the latest changes in the application.
247247

248248
#. 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.
250250
#. Run the End-to-End Tests locally using ``npm run test:tutorial``. This will generate new screenshots in the ``docs/assets/tutorials`` directory.
251251
#. Review the new screenshots to ensure they are accurate.
252252
#. 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.

docs/tutorials/dataset_publication.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Dataset Publication
44
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.
55

66
.. 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.
88

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.
1010

1111
Once your account is approved, you can move on to the next steps.
1212

@@ -24,31 +24,31 @@ You'll now notice that the **Exit Pipeline** button has been replaced with **Nex
2424

2525
DANDI Upload
2626
------------
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.
2828

2929
.. figure:: ../assets/tutorials/dandi/api-tokens.png
3030
:align: center
3131
:alt: A pop-up asking for DANDI API keys
3232

33-
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.
3434

3535
.. figure:: ../assets/dandi/api-token-location.png
3636
:align: center
37-
:alt: DANDI Development server API key added
37+
:alt: DANDI Sandbox server API key added
3838

3939
Provide this for the Development API Key value on the GUIDE.
4040

4141
.. figure:: ../assets/tutorials/dandi/api-token-added.png
4242
:align: center
43-
:alt: DANDI staging API key added
43+
:alt: DANDI sandbox API key added
4444

4545
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.
4646

4747
But what if you don't have any Dandisets to upload to? No problem!
4848

4949
Creating a Dandiset
5050
^^^^^^^^^^^^^^^^^^^
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.
5252

5353
Press the **Create New Dandiset** button to open a pop-up that guides you through the required fields for Dandiset creation.
5454

docs/tutorials/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@ In these tutorials, you'll follow along on a :doc:`local installation of the GUI
99
Watch a video walkthrough of these tutorials `here <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.
1010

1111
.. note::
12-
This tutorial focuses on uploading to the DANDI Development server.
12+
This tutorial focuses on uploading to the DANDI Sandbox server.
1313

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.
1515

1616
.. note::
1717

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.
1919

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 <>`.
2121

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.
2323

2424
Before you begin these tutorials, **you'll need to generate the tutorial dataset** using the instructions on the Dataset page.
2525

0 commit comments

Comments
 (0)