Skip to content

Conversation

@mariajgrimaldi
Copy link
Contributor

@mariajgrimaldi mariajgrimaldi commented Jun 13, 2023

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",
        ]
    },
}
  1. 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.
  2. 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 mariajgrimaldi marked this pull request as ready for review June 21, 2023 13:21
@mariajgrimaldi mariajgrimaldi requested review from a team and BryanttV June 21, 2023 13:21
@@ -0,0 +1,11 @@
"""
Settings for gamma dashboard pages provider.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

note to author: update docstring

"""
Read / Update necessary project settings.
"""
settings.MAKO_TEMPLATE_DIRS_BASE.append(LIMESURVEY_ROOT_DIRECTORY / "templates")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@BryanttV: settings.LIMESURVEY_API_TIMEOUT = 10

@mariajgrimaldi mariajgrimaldi merged commit f222211 into main Jun 21, 2023
@mariajgrimaldi
Copy link
Contributor Author

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

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