Skip to content

Commit 37822bb

Browse files
committed
Updated Sandbox pages documentation
1 parent 0466141 commit 37822bb

File tree

4 files changed

+16
-12
lines changed

4 files changed

+16
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
# Unreleased
44

5+
* Added task version update sandbox page (\#509);
56
* JSON Schema form improvements (\#509):
67
* supported enums of any type;
78
* supported tuples;

docs/json-schema-sandbox.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/sandbox-pages.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Sandbox pages
2+
3+
When developing tasks it can be useful to have a quick way to test how a given JSON schema will appear in the workflow task arguments form or how a task version update will affect the users.
4+
5+
When running fractal-web in development mode it is possible to use 2 sanbox pages:
6+
7+
* JSON Schema Sandbox page: http://localhost:5173/sandbox/jsonschema
8+
* Task Version Update Sandbox page: http://localhost:5173/sandbox/version
9+
10+
Both these pages provide a textarea for the JSON schemas. Notice that you can't paste the whole task manifest: you need to pick one of the `args_schema` values.
11+
12+
> The pages are visible only when the application is started in development mode, so typically when using `npm run dev`. It can be used also when fractal-server is not running.
13+
14+
It is preferable to use `npm run dev` if you want to access the Sandbox pages. If for any reason you need to use `npm run preview` consider that it works reading the files from the build folder. These files by default are built with the production mode set, so the only way to see the Sandbox pages when using `npm run preview` is to build the application using `npx vite build --mode development`.

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ nav:
5252
- OAuth2 integration: oauth2.md
5353
- Development: development/
5454
- Deployment examples: examples.md
55-
- JSON Schema Sandbox: json-schema-sandbox.md
55+
- Sandbox pages: sandbox-pages.md
5656

5757

5858
plugins:

0 commit comments

Comments
 (0)