Skip to content

Commit 6433935

Browse files
committed
General usage
1 parent cdbd964 commit 6433935

2 files changed

Lines changed: 26 additions & 0 deletions

File tree

content/docs/general-usage.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,36 @@ author: "OpenCourseMatch"
88

99
## Access the Web Application
1010

11+
The OpenCourseMatch web application is accessible through a web browser.
12+
Its URL is specified during the setup process (see [Deployment & Setup](/docs/deployment-and-setup)).
13+
1114
## Login
1215

16+
Each user has an own account with a unique username and a password.
17+
Later sections describe how these credentials are created.
18+
19+
![Login page](/img/login-page.png)
20+
1321
## Dashboard
1422

23+
After logging in, the user is redirected to the dashboard.
24+
It shows all the application's features that are available to the respective user group.
25+
1526
## Change Password
1627

28+
The user can change their password when logged in by navigating to the `Account settings` > `Change password` page.
29+
They are requested to enter their current password and the new password twice.
30+
The new password has to fulfill the following requirements:
31+
- At least 8 characters long
32+
- At least one uppercase letter
33+
- At least one lowercase letter
34+
- At least one number or special character
35+
36+
However, it is not possible to reset the password on their own if the user has forgotten it.
37+
Instead, it is necessary to contact an administrator, who can reset the password for them.
38+
1739
## Logout
40+
41+
The user can log out of the application by opening the sidebar through the hamburger icon in the top right corner and clicking on the `Log out` button.
42+
43+
The user is automatically logged out when the session expires, which usually happens after closing the browser.

static/img/login-page.png

276 KB
Loading

0 commit comments

Comments
 (0)