Skip to content

Conversation

@santhosh-apphelix-2u
Copy link
Contributor

@santhosh-apphelix-2u santhosh-apphelix-2u commented Jul 22, 2025

Proctortrack Documentation Cleanup Summary

As part of the Proctortrack deprecation:

  • Preserved Internally:

    • Migrated docs/developing.rstedx-documentation/en_us/developers/source/proctoring/proctortrack_setup.rst
    • Created new index.rst under proctoring/
    • Updated main index.rst to include this section
    • Retained original file in edx-proctoring repo per guidance
  • Removed (5 items):

    • docs/system-overview.rst – Removed outdated Proctortrack backend, JS worker, status references
    • docs/testing/test_plan.md – Removed Stage test courses, Proctortrack-specific cases & dashboard steps

Note: The preserved internal file added to the edx-documentation repo is currently on hold. This is due to wildcard redirects from all developers/ modules pointing to docs.opendex.org. We'll finalize the destination for 2U-internal content and move it accordingly in parallel.

Tracking Ticket: COSMO2-112
Coordination Thread: GitHub Issue #36329
DEPR: openedx/openedx-platform#36329

@santhosh-apphelix-2u santhosh-apphelix-2u changed the title Docs/remove proctortrack cosmo2 111 docs: remove proctortrack cosmo2 111 Jul 22, 2025
@santhosh-apphelix-2u santhosh-apphelix-2u changed the title docs: remove proctortrack cosmo2 111 docs: remove proctortrack related docs Jul 22, 2025
power of the ansible plays used to construct and administer
sandboxes, e.g. those run via the ``/edx/bin/update`` script.
`More on that here.`_
`More on that here. <https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/13960183/Sandboxes#Sandboxes-Updatingcode>`_

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the earlier version also the link doesn't exist.

Copy link
Contributor Author

@santhosh-apphelix-2u santhosh-apphelix-2u Jul 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the internal Link reference so wont be seen in preview mode. Anyway i have changed it to the directive prefix So you cant see it here.
Added in Line 257 - .. _More on that here.: https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/13960183/Sandboxes#Sandboxes-Updatingcode
the .. prefix in RST is a directive prefix
It's telling the RST processor that whenever it sees "More on that here" in the text, it should create a hyperlink to "https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/13960183/Sandboxes#Sandboxes-Updatingcode".

you've created, and share the client_id with folks on the other end
of the integration.

.. _our spec: ./backends.rst

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is not visible in the preview page

Copy link
Contributor Author

@santhosh-apphelix-2u santhosh-apphelix-2u Jul 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the deleted code so it wont be visible.
Check with the exact line number in Raw and then in preview

.. _system overview: ./system-overview.rst
.. _generate a public JWK keypair: https://mkjwk.org/
.. _More on that here.: https://openedx.atlassian.net/wiki/spaces/EdxOps/pages/13960183/Sandboxes#Sandboxes-Updatingcode
.. _System Overview: ./system-overview.rst

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link is not visible in the preview page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the Link for internal reference so wont be available in preview mode.
the .. prefix in RST is a directive prefix
It's telling the RST processor that whenever it sees "system overview_" in the text, it should create a hyperlink to the file "./system-overview.rst".

.. image:: images/attempt_states.png


Example Action Sequence

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 95 has Proctrotrack reference. Is this need to be handled along with the below image?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed the text slightly

- [ ] The exam timer is shown and functions properly. [Exam Timer](#exam-timer)
- [ ] Click end my exam on the banner
- [ ] Click submit on the confirmation page
- [ ] You should see an interstitial confirming the exam has been submitted and is waiting on review

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 102 has Proctrotrack reference? Is this to be handled?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I have removed.

@santhosh-apphelix-2u santhosh-apphelix-2u force-pushed the docs/remove-proctortrack-cosmo2-111 branch from 942cfe8 to 5cfac76 Compare July 25, 2025 02:44
Copy link
Contributor

@michaelroytman michaelroytman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good so far. Please let me know when it's out of the draft state if you have made any subsequent changes so that I can re-review.

@santhosh-apphelix-2u santhosh-apphelix-2u marked this pull request as ready for review July 31, 2025 01:36
@michaelroytman michaelroytman merged commit b491419 into openedx:master Jul 31, 2025
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants