Skip to content

Commit 03a538d

Browse files
committed
Rename staging to sandbox
1 parent d24a22f commit 03a538d

File tree

8 files changed

+17
-17
lines changed

8 files changed

+17
-17
lines changed

docs/api/rest-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The DANDI Archive provides a RESTful API that allows programmatic access to the
77
The DANDI API is available at:
88

99
- Production: [https://api.dandiarchive.org/](https://api.dandiarchive.org/)
10-
- Staging: [https://api-staging.dandiarchive.org/](https://api-staging.dandiarchive.org/)
10+
- Sandbox: [https://api-sandbox.dandiarchive.org/](https://api-sandbox.dandiarchive.org/)
1111

1212
## API Documentation
1313

@@ -16,7 +16,7 @@ The API documentation is available in three formats:
1616
### Swagger UI
1717

1818
- Production: [https://api.dandiarchive.org/swagger/](https://api.dandiarchive.org/swagger/)
19-
- Staging: [https://api-staging.dandiarchive.org/swagger/](https://api-staging.dandiarchive.org/swagger/)
19+
- Sandbox: [https://api-sandbox.dandiarchive.org/swagger/](https://api-sandbox.dandiarchive.org/swagger/)
2020

2121
The Swagger UI allows you to:
2222

@@ -28,7 +28,7 @@ The Swagger UI allows you to:
2828
### ReDoc
2929

3030
- Production: [https://api.dandiarchive.org/redoc/](https://api.dandiarchive.org/redoc/)
31-
- Staging: [https://api-staging.dandiarchive.org/redoc/](https://api-staging.dandiarchive.org/redoc/)
31+
- Sandbox: [https://api-sandbox.dandiarchive.org/redoc/](https://api-sandbox.dandiarchive.org/redoc/)
3232

3333
The ReDoc interface provides:
3434

docs/developer-guide/creating-dandi-instance/dandi-archive.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,9 @@ The only other major initial setup step for the DANDI Archive frontend is regard
100100

101101
## API Deployment with GitHub CI/CD
102102

103-
Within the DANDI Archive repository, GitHub actions workflows exist for deployments to [production](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-production-deploy.yml) and [staging](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-staging-deploy.yml) environments
103+
Within the DANDI Archive repository, GitHub actions workflows exist for deployments to [production](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-production-deploy.yml) and [sandbox](https://github.com/dandi/dandi-archive/blob/master/.github/workflows/backend-staging-deploy.yml) environments
104104

105-
- **Staging**: by default, releases are manual via the `workflow_dispatch` clause in the workflow
105+
- **Sandbox**: by default, releases are manual via the `workflow_dispatch` clause in the workflow
106106

107107
To invoke the pipeline, proceed to the `Actions` tab in GitHub and find the pipeline name in the column on the left
108108

docs/developer-guide/creating-dandi-instance/dandi-cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ known_instances = {
1616
"https://dandiarchive.org",
1717
"https://api.dandiarchive.org/api",
1818
),
19-
"dandi-staging": DandiInstance(
20-
"dandi-staging",
21-
"https://gui-staging.<your-domain>.org",
22-
"https://api-staging.<your-domain>.org/api",
19+
"dandi-sandbox": DandiInstance(
20+
"dandi-sandbox",
21+
"https://sandbox.<your-domain>.org",
22+
"https://api-sandbox.<your-domain>.org/api",
2323
),
2424
"dandi-api-local-docker-tests": DandiInstance(
2525
"dandi-api-local-docker-tests",

docs/developer-guide/creating-dandi-instance/dandi-infrastructure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -189,12 +189,12 @@ style="width: 60%; height: auto; display: block; margin-left: auto; margin-righ
189189

190190
Populate the value in the [appropriate account ID reference](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/main.tf#L14) in the `main.tf` template.
191191

192-
### Staging vs. Production
192+
### Sandbox vs. Production
193193

194-
For staging, you can modify and apply the [staging_bucket.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_bucket.tf)
194+
For sandbox, you can modify and apply the [staging_bucket.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_bucket.tf)
195195
and [staging_pipeline.tf](https://github.com/dandi/dandi-infrastructure/blob/master/terraform/staging_pipeline.tf).
196196

197-
Setting up staging will require unique AWS Route 53 Domains, as well a different Heroku app with different compute.
197+
Setting up sandbox will require unique AWS Route 53 Domains, as well a different Heroku app with different compute.
198198

199199
**Note -- ensure you review your `web/netlify.toml` file in DANDI Archive -- this will define different environment variables that correspond with staging vs. production**
200200

docs/developer-guide/system-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Provisions the servers, worker processes, and the database for the API.
5454
* **Frontend server**: Serves a static build of the DANDI Archive frontend (Vue.js).
5555
* **Autodeployment**: On each push or merge to `main` (or whichever branch is configured), Netlify automatically builds and deploys.
5656
* **Configuration**:
57-
- **`netlify.toml`**: Describes build commands, environment variables for staging vs. production.
57+
- **`netlify.toml`**: Describes build commands, environment variables for sandbox vs. production.
5858
- **`.env.production`**: Holds the environment variables for the Vue-based app at runtime (e.g. `VITE_API_URL`, `VITE_SENTRY_DSN`).
5959

6060
### 4. Terraform Infrastructure

docs/getting-started/creating-account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ With an account, users can create and edit Dandisets, and use the DANDI Hub to a
77
DANDI provides two servers:
88

99
- **Main server**: [https://dandiarchive.org/](https://dandiarchive.org/) - This is the primary platform for most users.
10-
- **Staging server**: [https://gui-staging.dandiarchive.org/](https://gui-staging.dandiarchive.org/) - Ideal for training and testing purposes.
10+
- **Sandbox server**: [https://sandbox.dandiarchive.org/](https://sandbox.dandiarchive.org/) - Ideal for training and testing purposes.
1111

1212
Accounts are independently managed on each server, allowing users to register on one or both, depending on their testing and deployment needs.
1313

docs/user-guide-sharing/creating-dandiset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Before creating a Dandiset, you should:
99
1. **Register for DANDI and obtain an API key.** To create a new Dandiset, you need to have a DANDI account.
1010
* If you do not already have an account, see [Create a DANDI Account](../getting-started/creating-account.md) page for instructions.
1111
* Once you are logged in, copy your API key by clicking on your user initials in the top-right corner after logging in.
12-
* Production (https://dandiarchive.org) and staging (https://gui-staging.dandiarchive.org) servers have different API keys and different logins.
12+
* Production (https://dandiarchive.org) and sandbox (https://sandbox.dandiarchive.org) servers have different API keys and different logins.
1313

1414
2. **Choose a server.**
1515
* **Production server**: https://dandiarchive.org. This is the main server for DANDI and should be used for sharing neuroscience data.
1616
When you create a Dandiset, a permanent ID is automatically assigned to it.
1717
This Dandiset can be fully public or embargoed according to NIH policy.
1818
All data are uploaded as draft and can be adjusted before publishing on the production server.
19-
* **Development server**: https://gui-staging.dandiarchive.org. This server is for testing and learning how to use DANDI.
19+
* **Development server**: https://sandbox.dandiarchive.org. This server is for testing and learning how to use DANDI.
2020
It is not recommended for sharing data, but is recommended for testing the DANDI CLI and GUI or as a testing platform for developers.
2121
Note that the development server should not be used to stage your data.
2222

docs/user-guide-sharing/uploading-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ For command-line users or those with larger datasets, the DANDI CLI provides a p
5454
```
5555
To upload to the development server, use:
5656
```bash
57-
dandi upload -i dandi-staging
57+
dandi upload -i dandi-sandbox
5858
```
5959

6060
## Storing Access Credentials

0 commit comments

Comments
 (0)