Skip to content

Commit 67a209c

Browse files
committed
docs: TESTING
1 parent 1bce266 commit 67a209c

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

TESTING.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
11
# How to Test
22

3-
## Local Server
3+
- [On Free Machine](#preview-server)
4+
- [On Your Machine](#ad-hoc-server)
5+
- [On Our Machine](#test-server)
46

5-
> [!WARNING]
6-
> Testing is manual and requires using a command prompt.
7+
## On Free Machine
8+
9+
> [!TIP]
10+
> Create a pull request; automatically get a remote preview server.
711
8-
You can [test with **PIP** or **Poetry** or **Docker** or **Make**](https://tacc.github.io/mkdocs-tacc/test/#test-locally) as a client.
12+
## On Your Machine
913

10-
## Remote Server
14+
> [!NOTE]
15+
> Run a server manually or programatically on your machine.
1116
12-
> [!WARNING]
13-
> Your test may be overridden by others working on the same test server.
17+
You can [test with **PIP** or **Poetry** or **Docker** or **Make**](https://tacc.github.io/mkdocs-tacc/test/#test-locally).
1418

15-
Deploy to our test server:
19+
## On Our Machine
20+
21+
> [!WARNING]
22+
> Only authorized contributors may deploy to our test server.
1623
1724
0. Have a branch with changes ready to deploy.
18-
1. On your branch, edit the [pre-prod workflow config](./.github/workflows/build-pprd.yml) `branches:` list.
25+
1. On your branch, edit the [pre-prod workflow config](./.github/workflows/build-pprd.yml) `branches:` list to include your branch.
1926
2. Commit the change to trigger the workflow.
2027
3. Wait for [GitHub action](https://github.com/DesignSafe-CI/ds-user-guide/actions) to complete.
2128
4. Load https://pprd.designsafe-ci.org/user-guide/.
2229

23-
> [!TIP]
24-
> In the future, we will offer a dedicated test server. Task is pending [issue #61](https://github.com/DesignSafe-CI/DS-User-Guide/issues/61).
30+
> [!CAUTION]
31+
> Others can override your test by deploying to this server.

0 commit comments

Comments
 (0)