Skip to content

[Documentation:System] Clarify adduser_course.py usage #732

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.

Sign up for GitHub

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
ojasvagr123 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Documentation:System] Clarify adduser_course.py usage #732

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 18 additions & 2 deletions _docs/sysadmin/configuration/course_creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down