Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add instructor dashboard filter integration #33196

Closed

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Sep 7, 2023

Description

Backport of #32448

This PR adds a new filter to modify the instructor dashboard rendering process. For example: modify the section tabs of the instructor context --that specifies which tabs to render, adding a brand new one defined in a different plugin. The use case we're currently testing is to add a new tab to the instructor dashboard, which renders management information about an Xblock.

Supporting information

PR in openedx-filters merged a few weeks ago: openedx/openedx-filters#96
This effort is part of the on-campus initiative and it's currently being used by: LimeSurvey + Open edX integration

Testing instructions

In case you want to test out our LimeSurvey+ Open edX integration with your own LimeSurvey service:

  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, and configure it following the instructions in xblock's README file
  2. Go to the instructor dashboard with the proper permissions (as an instructor of the course). You'll see:
    image

Deadline

None

Other information

More on Open edX filters: https://docs.openedx.org/projects/openedx-filters/en/latest/

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 7, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 7, 2023

Thanks for the pull request, @mariajgrimaldi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

This is currently a draft pull request. When it is ready for our review and all tests are green, click "Ready for Review", or remove "WIP" from the title, as appropriate.

This PR adds a new filter to modify the instructor dashboard rendering process. For example: modify the section tabs of the instructor context --that specifies which tabs to render, adding a brand new one defined in a different plugin. The use case we're currently testing is to add a new tab to the instructor dashboard, which renders management information about an Xblock.
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review September 7, 2023 14:19
@mariajgrimaldi mariajgrimaldi marked this pull request as draft September 7, 2023 14:34
@openedx-webhooks
Copy link

@mariajgrimaldi Even though your pull request wasn’t merged, please take a moment to answer a two question survey so we can improve your experience in the future.

@nedbat nedbat deleted the MJG/instructor-filter-palm branch January 8, 2024 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants