Skip to content

Commit 6458299

Browse files
JManion32bmcutler
andauthored
[Documentation:InstructorUI] Gradeable Config Editor (#707)
Added documentation for the gradeable config editor. I'm unsure if the pictures make the instructions too explicit, but I figured I'd leave that up to discussion. --------- Co-authored-by: Barb Cutler <[email protected]>
1 parent 7f5cbd9 commit 6458299

File tree

3 files changed

+30
-0
lines changed

3 files changed

+30
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
category: Instructor > Assignment Configuration Editor
3+
title: Configuration Editor
4+
---
5+
6+
The Gradeable Autograding Configuration Text Editor allows instructors to quickly view and make minor adjustments to a gradeable’s autograding configuration directly on the site. It can be found below the [autograding upload section](https://submitty.org/instructor/assignment_configuration/configuration_path) on the `Submissions / Autograding` page within a gradeable’s settings.
7+
8+
![](/images/instructor/assignment_configuration/gradeable_config_editor.png)
9+
10+
### Features
11+
12+
#### Adding Directories & Files
13+
You can add new directories to the root level, and add individual files either to the root level or within existing folders. If you need to add a folder that already contains files, consider re-uploading the configuration instead.
14+
15+
#### Removing Directories & Files
16+
17+
You can delete individual files or entire directories from the configuration as needed. **_Note: Deleting a directory will also remove all of its contents!_** By design, you cannot delete the entire configuration or the `config.json` file.
18+
19+
#### Downloading Configuration
20+
Download a ZIP file of your current configuration by clicking the download icon next to the folder. This download button is also next to the configuration on the autograding upload page.
21+
22+
#### Customizing the Editor
23+
The text editor uses CodeMirror to enhance the editing experience. Use the buttons in the top-right corner of the text editor to:
24+
1. Toggle line number visibility.
25+
2. Switch the tab size between 2 and 4 spaces.
26+
27+
---
28+
29+
_Note: This feature is only available for uploaded configurations. It does not yet support configurations pulled from the private courses repository._
231 KB
Loading

navtreedata.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ var NAVTREE =
119119
] ],
120120
[ "Assignment Configuration", "/instructor/assignment_configuration/configuration_path", [
121121
[ "Configuration Path","/instructor/assignment_configuration/configuration_path", null],
122+
[ "Configuration Editor", "/instructor/assignment_configuration/configuration_editor", null ],
122123
[ "Notebook", "/instructor/assignment_configuration/notebook", null ]
123124
] ],
124125
[ "Autograding", "/instructor/autograding/directory_structure", [

0 commit comments

Comments
 (0)