From 71fa6c60e6ae548ac2ea2c14540f1d8af993bcd1 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Thu, 9 May 2024 13:20:54 -0500 Subject: [PATCH] docs: add new settings docs --- README.rst | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index d6177e8..819771a 100644 --- a/README.rst +++ b/README.rst @@ -214,7 +214,24 @@ Instructors endpoints Configuring required in the Open edX platform ********************************************* -You need to configure the following settings to use the plugin: +By default the turnitin functionality is disabled. If you want to enable the +functionality globally (in all courses) add the following setting in your LMS: + +.. code-block:: python + + TURNITIN_SUBMISSION_ENABLED = True + +Optionally, you can enable the functionality in a specific course by adding the +following setting from **Studio** > **Advanced Settings** > **Other Course +Settings** + +.. code-block:: json + { + "TURNITIN_SUBMISSION_ENABLED": true + } + +Finally, to use the turnitin API it is necessary to configure the following +settings in your LMS: .. code-block:: python