Skip to content

Commit 694ef08

Browse files
[Documentation:System] Clarify adduser_course.py usage (#732)
Closes Submitty/Submitty#10341 **Why is this Change Important & Necessary?** The Course Creation documentation shows an outdated example using `null` with `adduser_course.py` and does not explain how to add non-instructor users using the `--user_group` option. Since the script now supports an optional numeric `REGISTRATION_SECTION` and a `--user_group` argument (default `1`, Instructor), the documentation should reflect the current implementation to avoid confusion for system administrators. **What is the New Behavior?** The Course Creation page now: - Uses the current `--user_group` syntax instead of `null`. - Documents the general command format for `adduser_course.py`. - Explains the `user_group` roles (Instructor, Full/ Limited Grader, Student). - Clarifies that `REGISTRATION_SECTION` is optional and must be numeric. **What steps should a reviewer take to verify this change?** 1. Open the Course Creation documentation page. 2. Locate the section “Add existing instructor(s) to the course database.” 3. Confirm the updated example, command format, and role descriptions. **Automated Testing & Documentation** This is a documentation-only change. No automated testing is required. **Other information** This is my first contribution to Submitty. I reviewed the current `sbin/adduser_course.py` implementation to ensure the documentation accurately reflects its behavior. Co-authored-by: Barb Cutler <bmcutler@users.noreply.github.com>
1 parent c7ee3d6 commit 694ef08

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

_docs/sysadmin/configuration/course_creation.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,11 +154,27 @@ you can follow these [instructions](ansible_course_creation) to create a course
154154
For more information: [Database Overview](/sysadmin/troubleshooting/database_overview)
155155
156156
157-
3. Add existing instructor(s) to the course database:
157+
3. Add existing instructor(s) to the course database, and optionally add other
158+
types of users using the `adduser_course.py` helper script.
159+
To add an existing instructor:
158160
159161
```
160-
sudo /usr/local/submitty/sbin/adduser_course.py <USERNAME> <SEMESTER> <COURSE> null
162+
sudo /usr/local/submitty/sbin/adduser_course.py <INSTRUCTOR_USERNAME> <SEMESTER> <COURSE> --user_group 1
161163
```
164+
The general command format is:
165+
166+
```
167+
sudo /usr/local/submitty/sbin/adduser_course.py <USER_ID> <SEMESTER> <COURSE> [REGISTRATION_SECTION] [--user_group GROUP]
168+
```
169+
170+
- `REGISTRATION_SECTION` is optional and must be numeric.
171+
172+
- `--user_group` defines the user's role in the course and defaults to `1` (Instructor) if omitted.
173+
174+
- `1` – Instructor
175+
- `2` – Full Access Grader
176+
- `3` – Limited Access Grader
177+
- `4` – Student
162178
163179
164180
4. Create registration section(s):

0 commit comments

Comments
 (0)