An Open edX plugin that adds a per-block “Send feedback” trigger to applicable leaf blocks in the LMS via an XBlockAside. The trigger is shown only to authenticated learners (never in Studio author/preview mode and never to anonymous users).
When a learner clicks the trigger the aside posts an ol-feedback::drawer-open message to its parent window (the Learning MFE) using window.parent.postMessage. The message payload carries the block context needed to identify the content being rated:
courseId — the course key
blockUsageKey — the block’s usage key
blockType — the XBlock category (e.g. problem, video)
blockDisplayName — the block’s display name
The Learning MFE receives the message and opens the feedback drawer, which submits the learner’s feedback directly to the mit-learn service. This plugin does not persist anything in edx-platform and exposes no REST API.
Installation
Install the package into the LMS Python environment:
pip install ol-openedx-feedbackThe plugin registers itself automatically through its entry points — the xblock_asides.v1 aside plus the lms.djangoapp app config — so no changes to INSTALLED_APPS are required. Restart the LMS after installing. (The trigger is learner-facing only, so the plugin is LMS-only and is not installed in Studio/CMS.)
Enable XBlock asides in the LMS admin
XBlock asides must be turned on for any aside (including this one) to render. In the LMS Django admin, open XBlock Asides Config (/admin/lms_xblock/xblockasidesconfig/), add a new entry, and check Enabled. Make sure the block types you want the feedback trigger on are not listed in Disabled blocks (the space-separated field defaults to about course_info static_tab).
Enablement
Feedback is gated by the ol_openedx_feedback.feedback_enabled course waffle flag (default off). Enable it for the desired courses (or globally) to roll out.
Configuration
By default the trigger renders on every leaf block and is suppressed only on structural containers (course / chapter / sequential / vertical). To additionally exclude one or more block types (for example html), override the excluded set through ENV_TOKENS (e.g. in lms.yml):
OL_OPENEDX_FEEDBACK_EXCLUDED_BLOCK_TYPES:
- course
- chapter
- sequential
- vertical
- htmlThe plugin reads this value via its settings.common plugin_settings hook and exposes it as the OL_OPENEDX_FEEDBACK_EXCLUDED_BLOCK_TYPES Django setting, defaulting to the structural set above when unset.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ol_openedx_feedback-0.1.0.tar.gz.
File metadata
- Download URL: ol_openedx_feedback-0.1.0.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54c99e88577320cec921a577a6c0e2d9c7ef077a9e2dd3c3c507f8ac7e7e27e9
|
|
| MD5 |
e8b793ab977acbf4a77c0557f3a4d1b8
|
|
| BLAKE2b-256 |
54c4fa3e0841c43619e035750fd92141bc3770e29b655c5742ff7533e76bcdb5
|
File details
Details for the file ol_openedx_feedback-0.1.0-py3-none-any.whl.
File metadata
- Download URL: ol_openedx_feedback-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
da09429a6d591ed3b49362c04ebdef9582279b52ff3a7cf203d976d02fb3a5ef
|
|
| MD5 |
3730c90c8e42516c87253e3467b89494
|
|
| BLAKE2b-256 |
b6427ccb1abc4169e7dd9b19b3b88e7434e1628635ae58f2067650c671653120
|
