preparing for release 2.0

SafeExamBrowser · Aug 29, 2024 · cc27f9d · cc27f9d
1 parent c6999e7
commit cc27f9d
Show file tree

Hide file tree

Showing 29 changed files with 5 additions and 250 deletions.
diff --git a/docs/exam_proctoring.rst b/docs/exam_proctoring.rst
diff --git a/docs/exam_template.rst b/docs/exam_template.rst
@@ -56,12 +56,7 @@ And you are able to add/edit/remove monitoring indicators for the exam template
  :align: center
  :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_template/indicator.png
 
-There are also proctoring settings available since SEB Server version 1.4 for the exam template. They just have the same settings and
-look like the ones on the Exam and will get copied for an exam imported with the respective template that defines the proctoring settings.
-
-.. image:: images/exam_template/proctoringSettings.png
- :align: center
- :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/exam_template/proctoringSettings.png
+TODO Screen Proctoring Settings
 
 
 Import Exam with Template

diff --git a/docs/exams.rst b/docs/exams.rst
@@ -20,7 +20,7 @@ We will go through all the steps to setting up an exam for Safe Exam Browser wit
  exam_clientgroups
  exam_ask
  exam_restriction
- exam_proctoring
+ exam_screen_proctoring
  exam_list
  exam_template
 
diff --git a/docs/images/exam/addExamConfig.png b/docs/images/exam/addExamConfig.png
diff --git a/docs/images/exam/archiveExam1.png b/docs/images/exam/archiveExam1.png
diff --git a/docs/images/exam/editEncryptionPassword.png b/docs/images/exam/editEncryptionPassword.png
diff --git a/docs/images/exam/examASK.png b/docs/images/exam/examASK.png
diff --git a/docs/images/exam/examClientgroupAdd.png b/docs/images/exam/examClientgroupAdd.png
diff --git a/docs/images/exam/examClientgroups.png b/docs/images/exam/examClientgroups.png
diff --git a/docs/images/exam/examConfig.png b/docs/images/exam/examConfig.png
diff --git a/docs/images/exam/examIndicatorAdd.png b/docs/images/exam/examIndicatorAdd.png
diff --git a/docs/images/exam/examIndicators.png b/docs/images/exam/examIndicators.png
diff --git a/docs/images/exam/examReady.png b/docs/images/exam/examReady.png
diff --git a/docs/images/exam/examWithURLView.png b/docs/images/exam/examWithURLView.png
diff --git a/docs/images/exam/importedExam.png b/docs/images/exam/importedExam.png
diff --git a/docs/images/exam/proctoringSEBSettings.png b/docs/images/exam/proctoringSEBSettings.png
diff --git a/docs/images/exam/proctoringSettings2.png b/docs/images/exam/proctoringSettings2.png
diff --git a/docs/images/exam/proctoringSettingsJITSI.png b/docs/images/exam/proctoringSettingsJITSI.png
diff --git a/docs/images/exam/proctoringSettingsZoom.png b/docs/images/exam/proctoringSettingsZoom.png
diff --git a/docs/images/exam/zoom1.png b/docs/images/exam/zoom1.png
diff --git a/docs/images/exam/zoom2.png b/docs/images/exam/zoom2.png
diff --git a/docs/images/exam/zoom3.png b/docs/images/exam/zoom3.png
diff --git a/docs/images/exam/zoom4.png b/docs/images/exam/zoom4.png
diff --git a/docs/images/exam/zoomauth1.png b/docs/images/exam/zoomauth1.png
diff --git a/docs/images/exam/zoomauth2.png b/docs/images/exam/zoomauth2.png
diff --git a/docs/images/exam/zoomauth3.png b/docs/images/exam/zoomauth3.png
diff --git a/docs/images/exam_template/proctoringSettings.png b/docs/images/exam_template/proctoringSettings.png
diff --git a/docs/images/exam_template/view.png b/docs/images/exam_template/view.png
diff --git a/docs/monitoring.rst b/docs/monitoring.rst
@@ -140,99 +140,10 @@ overview temporary network latency or other irregularities, when those two time
 
 In the detail view you are also able to use the instructions "Quit SEB Client" and "Mark as Canceled" for the selected SEB client connection.
 
-(Deprecated) Live Proctoring
-------------------------
+Screen Proctoring
+-----------------
 
-.. attention::
-
- Deprecation Note:
-
- The SEB Server live proctoring integration with Zoom and Jitsi Meet is deprecated in SEB Server 1.6.
- The upcoming version of SEB Server, targeted for August 2024, will remove the live proctoring integration with Zoom and Jitsi Meet.
-
-Live proctoring is a new and yet experimental feature of SEB and SEB Server. The feature is fully optional and not enabled by default.
-This section is about the live proctoring on monitoring a running exam and using the optional live proctoring within.
-To configure the optional live proctoring for a specific exam please have a look at `Optional Live Proctoring <https://seb-server.readthedocs.io/en/latest/exam_proctoring.html#sebProctoringSettings>`_ 
-
-.. note::
- This feature is still in a prototype state and not all functionality might work as expected. Basically, the meeting features
- are given or restricted by the meeting service that is used and the API and GUI that is given by that meeting service client
-
-
-**Proctoring (Collecting) Rooms**
-
-When the exam live proctoring feature is enabled for the running exam (see :ref:`sebProctoringSettings-label`), SEB Server will automatically create and collect 
-connected SEB clients into so called collecting rooms. The size of this collecting rooms can be defined within the proctoring settings in the exam.
-One proctor can then open such a collecting room by left-clicking on the room action. 
-SEB Server will then open a proctoring window and join the proctor to the meeting where the participants of this room can be seen.
-
-.. image:: images/monitoring/proctoringExam.png
- :align: center
- :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringExam.png
-
-A proctor is also able to view the names of all participants of a room by right-clicking on the specified room action.
-SEB Server will then open a dialog with a list of all participants. Double-clicking on a particular participant will automatically
-load the detailed monitoring view of that participant.
-
-.. note:: 
- A collecting room, once created, will live as long as the exam is running and not has been deleted. When the exam ends or is been deleted,
- the collecting room will automatically get deleted on the SEB Server's persistent storage as well as on the meeting service side if needed.
-
-**Town-Hall Feature**
-
-Besides the usual collecting room, there is a town-hall room feature. By using the "Open Townhall" action from the right action pane, SEB Server enforce all SEB clients that
-are in collecting rooms as well as new connecting SEB clients to leave their current meeting and join the town-hall meeting for as long as the town-hall is active.
-Within the town-hall a proctor has the same features as in the collecting room but can connect to all participants at the same time.
-When the town-hall is closed all connected SEB clients are enforced to leave the town-room and go back to its collecting room meetings again.
-
-.. note:: 
- This feature is only available if it is enabled within the exam proctoring settings in the exam administration.
-
-**Single Room or One-to-One Room Feature**
-
-Another live proctoring feature can be found in the detailed monitoring view of one particular SEB client connection. The single room features allows a proctor to connect to a single
-participant and being able to view or communication with just this one participant. You can initiate this single room connection by using the "Single Room Proctoring" action on 
-the right action pane. SEB Server will then enforce the involved SEB client to leave its collecting room and join a newly created room with the proctor. 
-Within the single room a proctor has the same features as in the collecting room to communicate with the student or participant.
-When the single room is closed the connected SEB clients is enforced to leave the single room and go back to its collecting room meetings again.
-
-.. image:: images/monitoring/proctoringClient.png
- :align: center
- :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringClient.png
-
-.. note:: 
- This feature is only available if it is enabled within the exam proctoring settings in the exam administration.
-
-**Broadcast Features**
-
-Within a live proctoring window, a proctor can use the enabled features of the integrated meeting service and is able to communicate with the SEB clients by using one
-of the following features if available for the service:
-
-- **Start Audio Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and a proctor can speak to the students that are in the meeting.
-- **Start Video Broadcast** Will enforce the SEB clients within the particular room to enable receive audio and video and proctor is shown to the students that are in the meeting and can speak to them as well.
-- **Enable Chat** Will enforce the SEB clients within the particular room to enable the chat feature and a proctor is able to chat with all students in the meeting.
-
-While a broadcast feature is enabled by a proctor, the SEB Server sends an instruction to each SEB client that is within the same meeting to display the meeting client.
-A student as well as a proctor is then able to use all the features of the meeting client of the integrated meeting service.
-
-.. image:: images/monitoring/proctoringWindow.png
- :align: center
- :target: https://raw.githubusercontent.com/SafeExamBrowser/seb-server/master/docs/images/monitoring/proctoringWindow.png
-
-.. note:: 
- Each of this features is only available if it is enabled within the exam proctoring settings in the exam administration.
-
-**Known Issues with Live Proctoring**
-
-- Within the Zoom service it often happens that a participant appears twice in a room or meeting. This is probably caused by SEB clients rejoining the meetings while rooms or feature settings are changed.
-- In Zoom it is not possible to fully control a participant microphone. Therefore, it may happen that participant can hear each other even if no proctor is in the meeting.
-- Within Jitsi Meet service when a proctor leaves the room it currently happens that a random participant became host/moderator since it is not possible in Jitsi Meet to have a meeting without host. We try to mitigate the problem with the `moderator plugin <https://github.com/nvonahsen/jitsi-token-moderation-plugin>`_ 
-- In both services while broadcasting, it is not guaranteed that a student always sees the proctor. Usually, the meeting service shows or pins the participant that is currently speaking automatically.
-
-.. note:: 
- The above listed points are issues within the current proctoring integration and not solutions. We are working hard to improve the 
- proctoring integration but due to limited resources this can take its time. And please consider that proctoring integration with 
- SEB Server is still in prototype state.
+TODO
 
 Finished Exams
 --------------