Skip to main content

XBlock for providing feedback on course content

Project description

License: AGPL v3 Status Python CI Publish package to PyPi

Purpose

XBlock is the Open edX component architecture for building custom learning interactives.

The FeedbackXBlock encourages learners to reflect on their learning experiences and allows instructors to capture feedback from learners. Feedback is provided as sentiment on a predefined scale and free text feedback. Feedback can be aggregated by instructors to understand which parts of a course work well and which parts work poorly.

The block can be placed anywhere in the courseware, and students can provide feedback related to those sections. With just a few database queries, we can compile that feedback into useful insights. ;) We do provide aggregate statistics to instructors, but not yet the text of the feedback.

The instructors can view reports in their course instructor dashboard. The reports shows the count for every score, the average sentiment score, and the last 10 feedback comments.

Tutor configuration

To enable the FeedbackXBlock report in the instructor dashboard, you can use the following tutor inline plugins:

name: feedback-xblock-settings
version: 0.1.0
patches:
  openedx-common-settings: |
    FEATURES["ENABLE_FEEDBACK_INSTRUCTOR_VIEW"] = True
    OPEN_EDX_FILTERS_CONFIG = {
      "org.openedx.learning.instructor.dashboard.render.started.v1": {
        "fail_silently": False,
        "pipeline": [
          "feedback.extensions.filters.AddFeedbackTab",
        ]
      },
    }

To enable this plugin you need to create a file called feedback-xblock-settings.yml in your tutor plugins directory of your tutor instance with the content of the previous code block, and run the following commands.

tutor plugins enable feedback-xblock-settings
tutor config save

You can find more information about tutor plugins in the Tutor plugins documentation.

Getting Started

For details regarding how to deploy this or any other XBlock in the lms instance, see the installing-the-xblock documentation.

Getting Help

If you’re having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.

Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.

For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.

https://github.com/openedx/FeedbackXBlock/issues

For more information about these options, see the Getting Help page.

How to Contribute

Details about how to become a contributor to the Open edX project may be found in the wiki at How to contribute

The Open edX Code of Conduct

All community members should familarize themselves with the Open edX Code of Conduct.

People

The assigned maintainers for this component and other project details may be found in Backstage or groked from inspecting catalog-info.yaml.

Reporting Security Issues

Please do not report security issues in public. Please email security@openedx.org.

History

This is a basic clone of Dropthought for use in Open edX. This used to be called the RateXBlock. We renamed it for better consistency. We are keeping the old one around for backwards-compatibility.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

feedback-xblock-2.0.0.tar.gz (94.5 kB view details)

Uploaded Source

Built Distribution

feedback_xblock-2.0.0-py3-none-any.whl (128.3 kB view details)

Uploaded Python 3

File details

Details for the file feedback-xblock-2.0.0.tar.gz.

File metadata

  • Download URL: feedback-xblock-2.0.0.tar.gz
  • Upload date:
  • Size: 94.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for feedback-xblock-2.0.0.tar.gz
Algorithm Hash digest
SHA256 8bfb8d3a773f9e06fc2a898ea68996938f735d09fd7f9eb79ed2db6714c674e1
MD5 cf5b8a7186674e939a5c9e6d81ce8faa
BLAKE2b-256 81410e0f2772a0b4f69bf5688bf41aa4e58d7bcd2c414f4eae3d7c0121bbfa99

See more details on using hashes here.

File details

Details for the file feedback_xblock-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for feedback_xblock-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 95accc75673de8082f1de8f4a59cde6a49e9638adea3a23c57eac207bc614006
MD5 7e53261872d2836f51a66bb1c793a208
BLAKE2b-256 ece61d1f262759c4ea2c81647e4721b9e8290f0bb18f8881cabddb08251d9819

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page