Added documentation about assigning user roles #5410
Merged
Conversation
This file contains 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
ragesoss
reviewed
May 26, 2023
docs/user_roles.md
Outdated
| @@ -39,6 +39,10 @@ permissions, or use another account and select the 'instructor' option from the | |||
| onboarding process (http://localhost:3000/onboarding). Either way, you'll be able | |||
| to create new courses/programs after that from the home page. | |||
|
|
|||
| ## Assigning special roles | |||
|
|
|||
| To assign users to special roles. Go to the `/settings` page in the dashboard (http://localhost:3000/settings). This will allow you to give users admin privileges and other special user permissions such as classroom program manager, technical help staff, Wikipedia expert and many others. Note that your account needs to have admin permissions to access the page (refer to [Admin permissions](#admin-permissions) for more information) | |||
There was a problem hiding this comment.
Adding special users actually requires super_admin permissions (permissions: 3), so this should probably add a note about that in the admin section as well.
ragesoss
reviewed
May 26, 2023
docs/user_roles.md
Outdated
| @@ -32,13 +32,21 @@ You can do so from the rails console: | |||
| - $ `rails c` | |||
| - > `User.find_by(username: '<your username>').update_attribute(:permissions, 1)` | |||
|
|
|||
| If you need a higher level of permission above admin. Consider giving your main account super admin permissions instead: | |||
There was a problem hiding this comment.
Grammar fix: "If you need a higher level of permission above admin, consider"
ragesoss
reviewed
May 26, 2023
docs/user_roles.md
Outdated
| ## Instructor role | ||
|
|
||
| To use the dashboard as an instructor, you can either use an account with admin | ||
| permissions, or use another account and select the 'instructor' option from the | ||
| onboarding process (http://localhost:3000/onboarding). Either way, you'll be able | ||
| to create new courses/programs after that from the home page. | ||
|
|
||
| ## Assigning special roles | ||
|
|
||
| To assign users to special roles. Go to the `/settings` page in the dashboard (http://localhost:3000/settings). This will allow you to give users admin privileges and other special user permissions such as classroom program manager, technical help staff, Wikipedia expert and many others. Note that your account needs to have super admin permissions to access the page (refer to [Admin permissions](#admin-permissions) for more information) |
There was a problem hiding this comment.
"To assign users to special roles, go"
Also, add a period at the end.
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.
What this PR does
Adds some extra information to
user_roles.mdabout the /setting page that allows for easy role assignment.