[Documentation:System] Clarify adduser_course.py usage#732
Open
ojasvagr123 wants to merge 1 commit intoSubmitty:mainfrom
Open
[Documentation:System] Clarify adduser_course.py usage#732ojasvagr123 wants to merge 1 commit intoSubmitty:mainfrom
ojasvagr123 wants to merge 1 commit intoSubmitty:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes Submitty/Submitty#10341
Why is this Change Important & Necessary?
The Course Creation documentation shows an outdated example using
nullwith
adduser_course.pyand does not explain how to add non-instructorusers using the
--user_groupoption. Since the script now supports anoptional numeric
REGISTRATION_SECTIONand a--user_groupargument(default
1, Instructor), the documentation should reflect the currentimplementation to avoid confusion for system administrators.
What is the New Behavior?
The Course Creation page now:
--user_groupsyntax instead ofnull.adduser_course.py.user_grouproles (Instructor, Full/ Limited Grader, Student).REGISTRATION_SECTIONis optional and must be numeric.What steps should a reviewer take to verify this change?
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.pyimplementation to ensure the documentationaccurately reflects its behavior.