diff --git a/_docs/instructor/course_settings/live_chat.md b/_docs/instructor/course_settings/live_chat.md new file mode 100644 index 00000000..1e3c0271 --- /dev/null +++ b/_docs/instructor/course_settings/live_chat.md @@ -0,0 +1,25 @@ +--- +category: Instructor > Course Settings +title: Live Chat +--- + +See also [Student -- Communication -- Live Chat](/student/communication/live_chat). + +## Enabling Live Chat + +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: + +![](/images/live_chat/live_chat_menu_admin.png) + +To create a new chat, click the New Chatroom button and enter your desired name, description, and anonymity (the description may be blank): + +![](/images/live_chat/live_chat_creation.png) + + +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. + +![](/images/live_chat/live_chat_edit.png) + +An instructor can join the chatroom and leave messages while it is enabled or disabled: + +![](/images/live_chat/live_chat_instructor_access.png) \ No newline at end of file diff --git a/_docs/student/communication/live_chat.md b/_docs/student/communication/live_chat.md new file mode 100644 index 00000000..50e58e00 --- /dev/null +++ b/_docs/student/communication/live_chat.md @@ -0,0 +1,27 @@ +--- +category: Student > Communication +title: Live Chat +--- + +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. + +## Live Chat Usage + +Once your instructor has enabled Live Chat, it will appear on the sidebar for student use: + + + +Upon clicking on Live Chat, you will be met with this menu: + +![](/images/live_chat/live_chat_menu.png) + +When an instructor enables live chat, a chat entry will appear. Your instructor may have enabled the ability to join Anonymously as shown below: + +![](/images/live_chat/live_enabled_chat.png) + +You can now enter Live Chat. There you will see messages from other Submitty users in your course: + +![](/images/live_chat/live_chat.png) + + +See also [Instructor -- Course Settings -- Live Chat](/instructor/course_settings/live_chat). \ No newline at end of file diff --git a/images/live_chat/live_chat.png b/images/live_chat/live_chat.png new file mode 100644 index 00000000..05c399d5 Binary files /dev/null and b/images/live_chat/live_chat.png differ diff --git a/images/live_chat/live_chat_creation.png b/images/live_chat/live_chat_creation.png new file mode 100644 index 00000000..7b2effdd Binary files /dev/null and b/images/live_chat/live_chat_creation.png differ diff --git a/images/live_chat/live_chat_edit.png b/images/live_chat/live_chat_edit.png new file mode 100644 index 00000000..d282716f Binary files /dev/null and b/images/live_chat/live_chat_edit.png differ diff --git a/images/live_chat/live_chat_icon_example.png b/images/live_chat/live_chat_icon_example.png new file mode 100644 index 00000000..2e4fcd44 Binary files /dev/null and b/images/live_chat/live_chat_icon_example.png differ diff --git a/images/live_chat/live_chat_instructor_access.png b/images/live_chat/live_chat_instructor_access.png new file mode 100644 index 00000000..424de02f Binary files /dev/null and b/images/live_chat/live_chat_instructor_access.png differ diff --git a/images/live_chat/live_chat_menu.png b/images/live_chat/live_chat_menu.png new file mode 100644 index 00000000..d2c579ff Binary files /dev/null and b/images/live_chat/live_chat_menu.png differ diff --git a/images/live_chat/live_chat_menu_admin.png b/images/live_chat/live_chat_menu_admin.png new file mode 100644 index 00000000..b2761780 Binary files /dev/null and b/images/live_chat/live_chat_menu_admin.png differ diff --git a/images/live_chat/live_enabled_chat.png b/images/live_chat/live_enabled_chat.png new file mode 100644 index 00000000..5b789936 Binary files /dev/null and b/images/live_chat/live_enabled_chat.png differ diff --git a/navtreedata.js b/navtreedata.js index 27ba946c..39cbea39 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -58,6 +58,7 @@ var NAVTREE = ] ], [ "Communication", "/student/communication/forum", [ [ "Discussion Forum", "/student/communication/forum", null ], + [ "Live Chat", "/student/communication/live_chat", null ], [ "Office Hours Queue", "/student/communication/office_hours_queue", null ], [ "Writing Markdown", "/student/communication/markdown", null ] ] ] @@ -83,6 +84,7 @@ var NAVTREE = [ "Course Settings", "/instructor/course_settings/index", [ [ "Overview", "/instructor/course_settings/index", null ], [ "Discussion Forum", "/instructor/course_settings/forum", null ], + [ "Live Chat", "/instructor/course_settings/live_chat", null ], [ "Submini Polling", "/instructor/course_settings/submini_polls", null ], [ "Office Hours Queue", "/instructor/course_settings/queue", null ], [ "Grade Inquiries", "/instructor/course_settings/grade_inquiries", null ],