[#12466] Clarify masquerade mode in docs #12470
Conversation
Changed the documentation for masquerade mode that the user should be the entire email address and not just the leading portion. ( New to this project so not 100% if it can be something that is not an email. )
|
Hi @JacksonsProfileViewer, thank you for your interest in contributing to TEAMMATES!
Please address the above before we proceed to review your PR. |
docs/development.md
Outdated
| 1. When logged in as administrator, ***masquerade mode*** can also be used to impersonate instructors and students by adding `user=username` to the URL | ||
| e.g `http://localhost:8080/web/student/home?user=johnKent`. | ||
| e.g `http://localhost:8080/web/student/home?user=johnKent@example.com` where the user to impersonate has a `username` of `johnKent@example.com`. |
There was a problem hiding this comment.
Let's change it to:
e.g http://localhost:8080/web/student/home?user=johnKent@example.com.
There was a problem hiding this comment.
GitHub doesn't allow me to suggest. Basically, remove everything from ...where the user to.... Let's shift this detail to the point above instead (refer to next comment). Thanks!
Co-authored-by: Dominic Lim <46486515+domlimm@users.noreply.github.com>
| 1. When logged in as administrator, ***masquerade mode*** can also be used to impersonate instructors and students by adding `user=username` to the URL | ||
| e.g `http://localhost:8080/web/student/home?user=johnKent`. | ||
| 1. When logged in as administrator, ***masquerade mode*** can also be used to impersonate instructors and students by adding `user=email` to the URL. Developers who want to use masquerade mode have to ensure that the username is the email address used to verify the user, e.g user@email.com, when signing up mock instructors. | ||
| e.g `http://localhost:8080/web/student/home?user=johnKent@example.com` where the user to impersonate has a `username` of `johnKent@example.com`. |
There was a problem hiding this comment.
| e.g `http://localhost:8080/web/student/home?user=johnKent@example.com` where the user to impersonate has a `username` of `johnKent@example.com`. | |
| e.g `http://localhost:8080/web/student/home?user=johnKent@example.com` where the user to impersonate has a username of `johnKent@example.com`. |
domlimm
added
s.Ongoing
|
Folks, This PR seems to be stalling (no activities for the past 7 days). 🐌 😢 |
1 similar comment
|
Folks, This PR seems to be stalling (no activities for the past 7 days). 🐌 😢 |
|
Hi @JacksonsProfileViewer, do take a look at the requested changes |
|
Closing due to inactivity. |
Fixes #12466
Outline of Solution
Changed the documentation for masquerade mode. Made it clear that the user should be the entire email address and not just the leading portion. ( New to this project so not 100% if it can't be something that is not an email. )