Skip to content

Commit b491419

Browse files
docs: remove proctortrack related docs (#1296)
1 parent f3c1754 commit b491419

3 files changed

Lines changed: 16 additions & 59 deletions

File tree

docs/developing.rst

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ in `local-module-development <https://github.com/openedx/frontend-app-learning#l
9191
How does the proctoring system work?
9292
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9393

94-
See `system overview`_ for a description of the proctoring system and it's components.
94+
See `System Overview`_ for a description of the proctoring system and it's components.
9595

9696

9797
Email Templates
@@ -251,36 +251,12 @@ The contents of ``EDXAPP_PROCTORING_BACKENDS`` will depend on which
251251
backend(s) you're interested in testing. It's necessary to provide a
252252
``DEFAULT`` backend.
253253

254-
Proctortrack
255-
""""""""""""
256-
257-
As will be the case with all REST backends implementing `our spec`_, one
258-
doesn't need to configure much to get Proctortrack working on a
259-
sandbox, e.g.::
260-
261-
EDXAPP_PROCTORING_BACKENDS:
262-
DEFAULT: 'proctortrack'
263-
proctortrack:
264-
client_id: "<you'll need to fill these in with credentials from Proctortrack>"
265-
client_secret: "<you'll need to fill these in with credentials from Proctortrack>"
266-
base_url: 'https://prestaging.verificient.com'
267-
integration_specific_email: "proctortrack-support@edx.org"
268-
269-
In addition to adding these configurations, you'll also need to set up
270-
a user which PT can authenticate as.
271-
272-
* Create a user group called ``proctortrack_review`` in Django admin
273-
* Create a user, and associate it with that group
274-
* Create an OAuth application
275-
(``/admin/oauth2_provider/application/``) pointing to the user
276-
you've created, and share the client_id with folks on the other end
277-
of the integration.
278-
279254
.. _our spec: ./backends.rst
280255
.. _system overview: ./system-overview.rst
281256
.. _generate a public JWK keypair: https://mkjwk.org/
282257
.. _More on that here.: https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/13960183/Sandboxes#Sandboxes-Updatingcode
283258

259+
284260
RPNow
285261
"""""
286262

docs/system-overview.rst

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ This can exist as a Python module or be committed directly into edx-proctoring a
5353

5454
`More information on configuring backends <https://github.com/openedx/edx-proctoring/blob/master/docs/backends.rst>`_
5555

56-
We have two real backends used in production:
56+
We have one real backend currently used in production:
57+
58+
1. RPNow: https://github.com/openedx/edx-proctoring/blob/447c0bf49f31fa4df2aa2b0339137ccfd173f237/edx_proctoring/backends/software_secure.py
5759

58-
#. Proctortrack: https://github.com/joshivj/edx-proctoring-proctortrack
59-
#. RPNow: https://github.com/openedx/edx-proctoring/blob/447c0bf49f31fa4df2aa2b0339137ccfd173f237/edx_proctoring/backends/software_secure.py
6060

6161
For testing backends see `mockprock <https://github.com/openedx/edx-proctoring/blob/master/docs/developing.rst#using-mockprock-as-a-backend>`_
6262

@@ -70,41 +70,31 @@ are required for each of these messages to keep the exam from entering an error
7070

7171
Message Interface: `exam_action_handler.js <https://github.com/openedx/edx-proctoring/blob/master/edx_proctoring/static/proctoring/js/exam_action_handler.js>`_
7272

73-
JavaScript Worker
74-
^^^^^^^^^^^^^^^^^
75-
This is an optional component currently used by Proctortrack and our Mockprock provider.
76-
77-
A JavaScript worker included as part of the the provider's python plugin. This will
78-
handle any messages emitted by the edX web application and interface directly with the
79-
proctoring software running on the learner's machine.
80-
81-
Example worker: `proctortrack_custom.js <https://github.com/joshivj/edx-proctoring-proctortrack/blob/master/edx_proctoring_proctortrack/static/proctortrack_custom.js>`_
82-
83-
See `Example Action Sequence`_ for how this interface fits into the exam process.
8473

8574
Exam States
8675
-----------
76+
8777
When a learner first enters a proctored exam subsection an exam attempt is created
8878
in the edX system. User actions and the proctoring provider will update the status of
8979
this attempt as the exam is completed and reviewed. The following diagram describes the
9080
flow through those status updates.
9181

92-
Detailed descriptions of each potential attempt state can be found below. It should be noted that there
93-
are minor differences in the review process between RPNow and Proctortrack exams.
82+
Detailed descriptions of each potential attempt state can be found below.
9483

95-
- `Proctortrack status values <https://docs.openedx.org/en/latest/educators/how-tos/proctored_exams/review_pt_results.html>`_
9684
- `RPNow status values <https://docs.openedx.org/en/latest/educators/how-tos/proctored_exams/review_rpnow_results.html>`_
9785

98-
This figure does not include error states or display of unmet prerequite requirements.
86+
This figure does not include error states or display of unmet prerequisite requirements.
9987

10088
.. image:: images/attempt_states.png
10189

90+
10291
Example Action Sequence
10392
-------------------------
10493

105-
The diagrams below describes the happy-path of interactions between components to
106-
sucessfully begin a proctored exam. These examples matches Proctortrack's backend
107-
implementation and includes any JavaScript events handled by the proctoring app.
94+
The diagram below describes the happy-path of interactions between components to
95+
successfully begin a proctored exam. These examples match the backend
96+
implementation of a typical proctoring provider and include any JavaScript events
97+
handled by the proctoring app.
10898

10999
Old Sequence
110100
^^^^^^^^^^^^

docs/testing/test_plan.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ This document should serve as a catalogue of key features included in the procto
55
## Resources
66

77
#### Test Courses in Stage
8-
- [course-v1:edX+cheating101+2018T3](https://learning.stage.edx.org/course/course-v1:edX+cheating101+2018T3/home) (Proctortrack)
9-
- [course-v1:edX+StageProctortrack+2019](https://learning.stage.edx.org/course/course-v1:edX+StageProctortrack+2019/home) (Proctortrack)
108
- [course-v1:Proctoring2+Proctoring2+Proctoring2](https://learning.stage.edx.org/course/course-v1:Proctoring2+Proctoring2+Proctoring2/home) (RPNow)
119

1210
#### Django Admin Models
@@ -30,7 +28,7 @@ This document should serve as a catalogue of key features included in the procto
3028
- [ ] A button or link to start the exam
3129
- [ ] Click the link to start the exam
3230
- [ ] You should see the first unit in the exam
33-
- [ ] The exam timer is shown and functions properly. [Exam Timer](#exam-timer)
31+
- [ ] The exam timer is shown and functions properly. [Exam Timer](#exam-timer)
3432
- [ ] Click end my exam using the timer banner
3533
- [ ] You should see an interstitial confirming if you want to submit
3634
- [ ] Submit the exam
@@ -96,12 +94,11 @@ This document should serve as a catalogue of key features included in the procto
9694
- [ ] There should be a functioning link to the support docs four proctored exam rules
9795
- [ ] Click start my exam
9896
- [ ] You should see the first unit in the exam
99-
- [ ] The exam timer is shown and functions properly. [Exam Timer](#exam-timer)
97+
- [ ] The exam timer is shown and functions properly. [Exam Timer](#exam-timer)
10098
- [ ] Click end my exam on the banner
10199
- [ ] Click submit on the confirmation page
102100
- [ ] You should see an interstitial confirming the exam has been submitted and is waiting on review
103101
- [ ] You should receive an email stating your exam has been submitted for review
104-
- [ ] This test has been completed with a Proctortrack exam
105102
- [ ] This test has been completed with a RPNow exam
106103

107104
#### <a name="error"></a> Learners are removed from the exam if connectivity to the proctoring software is not maintained
@@ -197,7 +194,7 @@ This document should serve as a catalogue of key features included in the procto
197194
- [ ] Get the `external_id` of both the resumed and submitted attempts from [Django Admin](#django-admin-models)
198195
- [ ] As an admin user use the external id of the resumed attempt to send a POST request to the exam review endpoint with a status of `passed`
199196
- [ ] An alternative is to wait for this review to come back organically (may take 24hrs)
200-
- [ ] As an admin user use the external id of the submitted attempt to send a POST request to the exam review endpoint with a status of `suspicious`
197+
- [ ] As an admin user use the external id of the submitted attempt to send a POST request to the exam review endpoint with a status of `suspicious`
201198
- [ ] Update the review from `suspicious` to `rules violation` in [Django Admin](#django-admin-models)
202199
- [ ] Validate the exam grade has been overridden to zero using gradebook (tab in instructor dashboard)
203200
- [ ] Query read replica to validate the certificate has been marked `unavailable` [Useful Queries](#useful-queries)
@@ -244,11 +241,5 @@ This document should serve as a catalogue of key features included in the procto
244241
- [ ] Filtering by "Not Started" it includes the learner(s) who has not started onboarding
245242
- [ ] Filtering by multiple statuses functions as expected
246243

247-
#### Proctortrack review dashboard is rendered for the correct course
248-
This is only applicable to Proctortrack courses
249-
- [ ] Navigate to the special exams tab within the instructor dashboard
250-
- [ ] Expand the "Review Dashboard" dropdown
251-
- [ ] The Proctortrack UI is rendered for the correct course
252-
253244
#### Additional Features
254245
- [ ] Allowances

0 commit comments

Comments
 (0)