eduNEXT / xblock-limesurvey

LimeSurvey XBlock for Open edX
GNU Affero General Public License v3.0
1 stars 0 forks source link

feat: add instructor dashboard filter for limesurvey integration #8

Closed mariajgrimaldi closed 1 year ago

mariajgrimaldi commented 1 year ago

Description: This PR adds a pipeline step which modifies the Instructor dashboard rendering process. This step adds extra context information to the template, adding a new tab section with management information about the Xblock.

Installation instructions: In case you want to test the use case shown here, you'll need a couple of stuff:

  1. Install the LimeSurvey Xblock in the LMS/CMS services: git+https://github.com/eduNEXT/xblock-limesurvey.git@MJG/instructor-tab
  2. Install this branch in the LMS/CMS services: git+https://github.com/openedx/openedx-filters.git@MJG/instructor-tab-filters
  3. Change your edx-platform branch to MJG/instructor-dashboard-filter
  4. Restart services

Testing instructions:

  1. Add the Open edX Filters configuration to your environment:
    OPEN_EDX_FILTERS_CONFIG = {
    "org.openedx.learning.instructor.dashboard.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
            "limesurvey.extensions.filters.AddInstructorLimesurveyTab",
        ]
    },
    }
  2. Add the LimeSurvey xblock as a component of your course, you can use dummy values for the Studio configuration. The student view doesn't really matter for these tests.
  3. Go to the instructor dashboard with the proper permissions (as an instructor of the course). You'll see: Screenshot from 2023-06-13 16-21-22
mariajgrimaldi commented 1 year ago

I'll merge this as it is for our first working version! We can change more things later on if needed.