feedback-xblock 3.0.1

XBlock for providing feedback on course content

Move

This repository is no longer maintained.

The FeedbackXBlock has been moved to xblocks-extra.

Please use the new repository for all future work.

FeedbackXBlock

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 [e-mail].

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.