From 473f7eadeaacdbae7c1bbfb5e4a1930eaacebb4d Mon Sep 17 00:00:00 2001 From: Nathan Walters Date: Tue, 12 Apr 2022 08:48:14 -0700 Subject: [PATCH] Reformat Markdown with Prettier --- docs/workspaces/index.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/workspaces/index.md b/docs/workspaces/index.md index 3c9c91c6666..a634cf8258d 100644 --- a/docs/workspaces/index.md +++ b/docs/workspaces/index.md @@ -55,17 +55,17 @@ questions The question's `info.json` should set the `singleVariant` and `workspaceOptions` properties: - `"singleVariant": true` will prevent student workspaces from resetting due to new variants being generated - - Note that new variants will still be generated in `Staff view` + - Note that new variants will still be generated in `Staff view` - `workspaceOptions` contains the following properties: - - `image`: Docker Hub image serving the IDE and containing the desired compilers, debuggers, etc. - - `port`: port number used by the workspace app inside the Docker image - - `home`: home directory inside the Docker image -- this should match the running user's home directory specified by the image maintainer and can't be used (for example) to switch the running user or their home directory - - `gradedFiles` (optional, default none): list of file paths (relative to the `home` path) that will be copied out of the workspace container for grading. Files can be in subdirectories, but the files must be explicitly listed (e.g. listing `dir/file.txt` is okay, but specifying `dir` alone is not). If a file is in a subdirectory, the relative path to the file will be reconstructed inside the autograder. - - `args` (optional, default none): command line arguments to pass to the Docker image - - `syncIgnore` (optional, default none): list of files or directories that will be excluded from sync - - `rewriteUrl` (optional, default true): if true, the URL will be rewritten such that the workspace container will see all requests as originating from / - - `enableNetworking` (optional, default false): whether the workspace should be allowed to connect to the public internet. This is disabled by default to make secure, isolated execution the default behavior. This restriction is not enforced when running PrairieLearn in local development mode. It is strongly recommended to use the default (no networking) for exam questions, because network access can be used to enable cheating. Only enable networking for homework questions, and only if it is strictly required, for example for downloading data from the internet. - - `environment` (optional, default `{}`): environment variables to set inside the workspace container. Set variables using `{"VAR": "value", ...}`, and unset variables using `{"VAR": null}` (no quotes around `null`). + - `image`: Docker Hub image serving the IDE and containing the desired compilers, debuggers, etc. + - `port`: port number used by the workspace app inside the Docker image + - `home`: home directory inside the Docker image -- this should match the running user's home directory specified by the image maintainer and can't be used (for example) to switch the running user or their home directory + - `gradedFiles` (optional, default none): list of file paths (relative to the `home` path) that will be copied out of the workspace container for grading. Files can be in subdirectories, but the files must be explicitly listed (e.g. listing `dir/file.txt` is okay, but specifying `dir` alone is not). If a file is in a subdirectory, the relative path to the file will be reconstructed inside the autograder. + - `args` (optional, default none): command line arguments to pass to the Docker image + - `syncIgnore` (optional, default none): list of files or directories that will be excluded from sync + - `rewriteUrl` (optional, default true): if true, the URL will be rewritten such that the workspace container will see all requests as originating from / + - `enableNetworking` (optional, default false): whether the workspace should be allowed to connect to the public internet. This is disabled by default to make secure, isolated execution the default behavior. This restriction is not enforced when running PrairieLearn in local development mode. It is strongly recommended to use the default (no networking) for exam questions, because network access can be used to enable cheating. Only enable networking for homework questions, and only if it is strictly required, for example for downloading data from the internet. + - `environment` (optional, default `{}`): environment variables to set inside the workspace container. Set variables using `{"VAR": "value", ...}`, and unset variables using `{"VAR": null}` (no quotes around `null`). #### `info.json` for ungraded workspace