Skip to content

[Documentation:InstructorUI] Gradeable Config Editor #707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ GEM
logger
faraday-net_http (3.1.1)
net-http
ffi (1.17.0-arm64-darwin)
ffi (1.17.0-x64-mingw-ucrt)
ffi (1.17.0-x86_64-linux-gnu)
ffi (1.17.2-arm64-darwin)
ffi (1.17.2-x64-mingw-ucrt)
ffi (1.17.2-x86_64-linux-gnu)
forwardable-extended (2.6.0)
gemoji (4.1.0)
github-pages (232)
Expand Down Expand Up @@ -239,11 +239,11 @@ GEM
mutex_m (0.2.0)
net-http (0.4.1)
uri
nokogiri (1.16.7-arm64-darwin)
nokogiri (1.18.9-arm64-darwin)
racc (~> 1.4)
nokogiri (1.16.7-x64-mingw-ucrt)
nokogiri (1.18.9-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.16.7-x86_64-linux)
nokogiri (1.18.9-x86_64-linux-gnu)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
Expand Down Expand Up @@ -280,6 +280,7 @@ GEM
concurrent-ruby (~> 1.0)
unicode-display_width (1.8.0)
uri (0.13.0)
wdm (0.2.0)
webrick (1.9.1)
yell (2.2.2)

Expand All @@ -294,6 +295,7 @@ DEPENDENCIES
github-pages (= 232)
html-proofer (~> 3.19.4)
json
wdm (>= 0.1.1)
webrick (~> 1.9)

BUNDLED WITH
Expand Down
31 changes: 31 additions & 0 deletions _docs/instructor/assignment_configuration/configuration_editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
category: Instructor > Assignment Configuration Editor
title: Configuration Editor
---

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.

![](/images/instructor/assignment_configuration/gradeable_config_editor.png)

### Features

#### Adding Directories & Files
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.

#### Removing Directories & Files

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.

#### Downloading Configuration
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.

#### Customizing the Editor
The text editor uses CodeMirror to enhance the editing experience. Use the buttons in the top-right corner of the text editor to:
1. Toggle line number visibility.
2. Switch the tab size between 2 and 4 spaces.

![](/images/instructor/assignment_configuration/config_editor_customization.png)

---

_Note: This feature is only available for uploaded configurations. It does not yet support configurations pulled from the private courses repository._
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions navtreedata.js
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ var NAVTREE =
] ],
[ "Assignment Configuration", "/instructor/assignment_configuration/configuration_path", [
[ "Configuration Path","/instructor/assignment_configuration/configuration_path", null],
[ "Configuration Editor", "/instructor/assignment_configuration/configuration_editor", null ],
[ "Notebook", "/instructor/assignment_configuration/notebook", null ]
] ],
[ "Autograding", "/instructor/autograding/directory_structure", [
Expand Down
Loading