From 24f4c4ab3538599809afd4c8843f2fa3ecacd0ca Mon Sep 17 00:00:00 2001 From: Alie Langston Date: Wed, 18 Dec 2024 14:27:46 -0500 Subject: [PATCH] docs: update setup instructions --- CHANGELOG.rst | 1 + README.rst | 11 +++++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 27e5be1..b1a632f 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -13,6 +13,7 @@ Change Log Unreleased ********** +* Updated setup docs 4.6.2 - 2025-12-18 ****************** diff --git a/README.rst b/README.rst index 72a11d7..289ddab 100644 --- a/README.rst +++ b/README.rst @@ -53,15 +53,22 @@ In your ``lms/envs/private.py`` settings file in edx-platform (create file if ne In devstack, run ``make lms-shell`` and run the following command: ``paver install_prereqs;exit``. This will install anything included in your ``private.txt`` requirements file. +In django admin, add the following waffle flag ``learning_assistant.enable_course_content`` and make sure it is turned on for Everyone. The flag should be checked on for: Superusers, Staff, and Authenticated. + +This plugin depends on the lms and discovery - both should be running. + +Enabling Xpert for audit learners +--------------------------------- +In addition to the "One Time Setup" instructions, the following instructions should be followed to enable Xpert for audit learners locally. In your ``env.development`` config file in frontend-app-learning, add the below setting. .. code-block:: ENABLE_XPERT_AUDIT='true' -In django admin, add the following waffle flag ``learning_assistant.enable_course_content`` and make sure it is turned on for Everyone. The flag should be checked on for: Superusers, Staff, and Authenticated. +Ensure that you have a non-expired verified mode set up locally for your testing course. You can do this by checking if http://localhost:18000/admin/course_modes/coursemode/ has a course mode with a future expiration date. -This plugin depends on the lms and discovery - both should be running. +The Xpert for audit learner frontend code depends on the lms, discovery, and ecommerce services. Ensure that all three services are running without errors. Every time you develop something in this repo ---------------------------------------------