Skip to content

Commit d1d5f6a

Browse files
martig7bmcutler
andauthored
[Documentation:Forum] Live Lecture Chat Documentation (#684)
This PR creates new documentation for the Live Lecture Chat feature. It may be necessary to create a new PR module for Lecture Chat. Related to PR Submitty/Submitty#10214 NOTE: The images all say "Live Lecture Chat", they will need to be replaced once the feature is updated to change the title to simply "Live Chat". --------- Co-authored-by: Barb Cutler <Barb Cutler> Co-authored-by: Barb Cutler <[email protected]>
1 parent 0844893 commit d1d5f6a

File tree

11 files changed

+54
-0
lines changed

11 files changed

+54
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
category: Instructor > Course Settings
3+
title: Live Chat
4+
---
5+
6+
See also [Student -- Communication -- Live Chat](/student/communication/live_chat).
7+
8+
## Enabling Live Chat
9+
10+
To enable Live Chat for a course, an instructor must go to the "Course Settings" page and click the checkbox labelled "Enable Live Chat". You can then access Live Chat from the left sidebar. When you enter the Live Chat menu, you will be shown a list of currently enabled and disabled chats:
11+
12+
![](/images/live_chat/live_chat_menu_admin.png)
13+
14+
To create a new chat, click the New Chatroom button and enter your desired name, description, and anonymity (the description may be blank):
15+
16+
![](/images/live_chat/live_chat_creation.png)
17+
18+
19+
You will then see your newly created channel, and you will be able to click Start Session to allow students to join the chat. Additionally, you can edit the Live Chat or delete the Live Chat if the chat is disabled.
20+
21+
![](/images/live_chat/live_chat_edit.png)
22+
23+
An instructor can join the chatroom and leave messages while it is enabled or disabled:
24+
25+
![](/images/live_chat/live_chat_instructor_access.png)
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
category: Student > Communication
3+
title: Live Chat
4+
---
5+
6+
The live chat feature allows Submitty users to engage in real time communication via their course page. Its primary use case is to allow for live participation within lectures, creating a similar ease of communication to an online lecture.
7+
8+
## Live Chat Usage
9+
10+
Once your instructor has enabled Live Chat, it will appear on the sidebar for student use:
11+
12+
<img src="/images/live_chat/live_chat_icon_example.png" width="200px">
13+
14+
Upon clicking on Live Chat, you will be met with this menu:
15+
16+
![](/images/live_chat/live_chat_menu.png)
17+
18+
When an instructor enables live chat, a chat entry will appear. Your instructor may have enabled the ability to join Anonymously as shown below:
19+
20+
![](/images/live_chat/live_enabled_chat.png)
21+
22+
You can now enter Live Chat. There you will see messages from other Submitty users in your course:
23+
24+
![](/images/live_chat/live_chat.png)
25+
26+
27+
See also [Instructor -- Course Settings -- Live Chat](/instructor/course_settings/live_chat).

images/live_chat/live_chat.png

498 KB
Loading
439 KB
Loading

images/live_chat/live_chat_edit.png

451 KB
Loading
45.3 KB
Loading
Loading

images/live_chat/live_chat_menu.png

345 KB
Loading
390 KB
Loading
359 KB
Loading

navtreedata.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ var NAVTREE =
5858
] ],
5959
[ "Communication", "/student/communication/forum", [
6060
[ "Discussion Forum", "/student/communication/forum", null ],
61+
[ "Live Chat", "/student/communication/live_chat", null ],
6162
[ "Office Hours Queue", "/student/communication/office_hours_queue", null ],
6263
[ "Writing Markdown", "/student/communication/markdown", null ]
6364
] ]
@@ -83,6 +84,7 @@ var NAVTREE =
8384
[ "Course Settings", "/instructor/course_settings/index", [
8485
[ "Overview", "/instructor/course_settings/index", null ],
8586
[ "Discussion Forum", "/instructor/course_settings/forum", null ],
87+
[ "Live Chat", "/instructor/course_settings/live_chat", null ],
8688
[ "Submini Polling", "/instructor/course_settings/submini_polls", null ],
8789
[ "Office Hours Queue", "/instructor/course_settings/queue", null ],
8890
[ "Grade Inquiries", "/instructor/course_settings/grade_inquiries", null ],

0 commit comments

Comments
 (0)