From 09e0ec74e3a3b4a01e0be7b3b2bd48471812219d Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 10 May 2024 09:29:21 -0500 Subject: [PATCH] docs: add filter settings to docs --- README.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.rst b/README.rst index 73abf16..d97a89c 100644 --- a/README.rst +++ b/README.rst @@ -231,6 +231,20 @@ Settings**: "ENABLE_TURNITIN_SUBMISSION": true } +Next, you must include the following setting to enable the filter that will +display the warning message to the learner about Turnitin: + +.. code-block:: python + + OPEN_EDX_FILTERS_CONFIG = { + "org.openedx.learning.ora.submission_view.render.started.v1": { + "fail_silently": False, + "pipeline": [ + "platform_plugin_turnitin.extensions.filters.ORASubmissionViewTurnitinWarning", + ] + }, + } + Finally, to use the turnitin API it is necessary to configure the following settings in your LMS: