Merge branch 'main' into dependabot/bundler/html-proofer-5.2.1

Author: bmcutler

Gemfile.lock

@@ -243,7 +243,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.18.1)
+    json (2.19.3)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)

_docs/instructor/assignment_preparation/personalized_exams.md

@@ -7,7 +7,7 @@ redirect_from:
 
 
 We provide scripts to prepare personalized exams for each student,
-facilitating randomized assigned seating, QR codes, and notes/crib sheets:
+facilitating randomized seating assignments, QR codes, and notes/crib sheets:
 
 
 * (Optional) Collect student left or right handedness.  
@@ -32,7 +32,7 @@ facilitating randomized assigned seating, QR codes, and notes/crib sheets:
     ```
 
 
-* Prepare a "blank" test as a .pdf file.  Be sure to empty space on
+* Prepare a "blank" test as a .pdf file.  Be sure to leave empty space on
   the first page to allow placment of the large box with student
   information and the QR code.
 
@@ -46,12 +46,12 @@ facilitating randomized assigned seating, QR codes, and notes/crib sheets:
   instructions to prepare personalized exams.
 
   Note that in addition to the QR code on the first page, the
-  student's name and email address is placed in the upper right corner
+  student's name and email address are placed in the upper right corner
   of all following pages.
 
   ![](/images/instructor/personalized_exam/personalized_page_1.png){:width="380px"}
   ![](/images/instructor/personalized_exam/personalized_page_2.png){:width="380px"}
 
 
 * _TODO: Write instructions for printing a large set of personalized exams
-  with our specific copier._
+  with our specific copier._

_docs/student/student_errors.md

@@ -8,11 +8,11 @@ title: Debugging Submitty Output
 
 Your code is not tested locally first, Submitty should be used as the
 final submission server, not as a debugger. Before submitting anything
-make sure that you are able to run your code locally without error.
+make sure that you are able to run your code locally without errors.
 In addition the instructor may decide to use hidden tests which still
 reveal the grade. Often these tests check corner cases and exactly what those
 could vary by your program but common cases to consider are positive, 
-negative, zero, and floating point values and how your code performs give
+negative, zero, and floating point values and how your code performs given
 unexpected but valid input.
 
 Often times there may be a missing punctuation or small typo in the output
@@ -45,21 +45,21 @@ perform operations slower than hashmaps or trees-like structures. If your code
 gets a kill signal and you are using specific data structures be sure you are
 using them correctly
 
-If you are using python, ineffeicant use of dictionaries, and sets can cause this error to occur.
+If you are using python, inefficient use of dictionaries, and sets can cause this error to occur.
 
 ![](/images/killSignal.png)
 
 ### Segmentation Fault
 
 For anyone who has ever programmed in a language with explicit memory management such as C/C++
-you are probably familiar with the infamous and seemingly unhelpful error know as Segmentation Fault.
+you are probably familiar with the infamous and seemingly unhelpful error known as Segmentation Fault.
 In short however a SegFault is the result of a memory access violation.
 
 This can occur for a number of reasons, first case we will look at is going out of bounds. 
 If while iterating over a list your index is out of the range of the list this can 
 result in a memory SegFault.
 
-Another possibly is when using pointers, if a pointer on the stack is initialzied to NULL
+Another possibility is when using pointers, if a pointer on the stack is initialzied to NULL
 or never initialized in the first place but you try to dereference it this is the same thing 
 as a NUllPointerException in Java and is a very common issue when dealing with pointers 
 which are commonly found when dealing with Tree structures and and linked lists.
@@ -70,6 +70,6 @@ but since submitty is a teaching tool lets assume the problems given are
 not so large that you run out of memory trying to solve it.  A common example 
 of this is infinite recursion. Make sure the base case is eventually called.
 
-There are other reasosn for SegFaults but these are very common examples.
+There are other reasons for SegFaults but these are very common examples.
 However what ever the reason DrMemory/Valgrind and gdb are excellent tools to 
 help with more advanced errors if print debugging isn't cutting it. 

_docs/student/testing_networks.md

@@ -9,7 +9,7 @@ title: Testing Networked Applications Locally
 We are currently hosting the docker images that will be used for grading on the
 [Docker Hub](https://hub.docker.com/u/submitty/).  
 
-You can can "pull" the most recent submitty images using the commands:  
+You can "pull" the most recent submitty images using the commands:  
 ```
 docker pull submitty/python:2.7
 docker pull submitty/python:3.6
@@ -34,7 +34,7 @@ docker create -i -t -v SOURCE_CODE_DIRECTORY:SOURCE_CODE_DIRECTORY -w SOURCE_COD
 ``-i`` boots the container in interactive mode, allowing submitty to pipe standard
 input to the containers.  
 
-``-t`` Allocates a pseudo-TTY so that you can interact with your container.  
+``-t`` allocates a pseudo-TTY so that you can interact with your container.  
 
 ``-v`` mounts a directory on the host machine so that output persists after the
 docker exits. ``SOURCE_CODE_DIRECTORY:SOURCE_CODE_DIRECTORY`` specifies first
@@ -61,7 +61,7 @@ Once you have created a few containers, you can create a network with this comma
 ```
 docker network create --driver bridge NETWORK_NAME
 ```
-Where you can specify your own network_name.
+You can specify your own network_name.
 
 Then, you can connect your containers to the network as follows:
 ```

_docs/sysadmin/configuration/course_creation.md

@@ -154,11 +154,27 @@ you can follow these [instructions](ansible_course_creation) to create a course
    For more information: [Database Overview](/sysadmin/troubleshooting/database_overview)
 
 
-3. Add existing instructor(s) to the course database:
+3. Add existing instructor(s) to the course database, and optionally add other 
+   types of users using the `adduser_course.py` helper script.
+   To add an existing instructor:
 
    ```
-   sudo /usr/local/submitty/sbin/adduser_course.py <USERNAME> <SEMESTER> <COURSE> null
+   sudo /usr/local/submitty/sbin/adduser_course.py <INSTRUCTOR_USERNAME> <SEMESTER> <COURSE> --user_group 1
    ```
+   The general command format is:
+
+   ```
+   sudo /usr/local/submitty/sbin/adduser_course.py <USER_ID> <SEMESTER> <COURSE> [REGISTRATION_SECTION] [--user_group GROUP]
+   ```
+
+   - `REGISTRATION_SECTION` is optional and must be numeric.
+
+   - `--user_group` defines the user's role in the course and defaults to `1` (Instructor) if omitted.
+
+     - `1` – Instructor  
+     - `2` – Full Access Grader  
+     - `3` – Limited Access Grader  
+     - `4` – Student  
 
 
 4. Create registration section(s):

_docs/sysadmin/installation/system_customization.md

@@ -372,7 +372,23 @@ You can customize the login screen with markdown. By default, `# Login` is rende
 
 Refer to [this](/student/communication/markdown) to learn more about markdown.
 
+## Preserving system customization files on system re-installation
 
+To prevent your system customization files (e.g., your institute logo on the login screen logo or your custom oage footer) from being overwritten or deleted from a system re-install, add these files to the follow JSON file:
+
+The JSON file will be generated at `CONFIG_DIR/preserve_file_list.json` which is most likely `/usr/local/submitty/config/preserve_files_list.json`
+
+the format will be as follows:  
+
+  ```
+  [  
+    "/path/to/file",  
+    "/more/files/,  
+    ...  
+  ]
+```
+
+These files will be preserved when INSTALL_SUBMITTY.sh is run on the system. 
 
 ## Changing the multi-processing module of Apache2, Enabling HTTP2