Skip to content

Commit

Permalink
docs: add information for instructor dashboard integration
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian2012 committed Dec 7, 2023
1 parent b71c52a commit f710dd0
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
35 changes: 35 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,41 @@ feedback.
.. |Scale where good is in the middle| image:: happy_sad_happy_example.png
.. |Numberical scale| image:: numerical_example.png

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:

.. code-block:: yaml
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.

.. code-block:: bash
tutor plugins enable feedback-xblock-settings
tutor config save
You can find more information about tutor plugins in the Tutor `plugins`_ documentation.

.. _plugins: https://docs.tutor.edly.io/tutorials/plugin.html

Getting Started
===============
Expand Down
2 changes: 1 addition & 1 deletion feedback/extensions/filters.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ def load_blocks(request, course):
"display_name": block.display_name,
"prompts": block.prompts,
"vote_aggregate": vote_aggregate,
"answers": answers,
"answers": answers[-10:],
"parent": parent.display_name,
"average_rating": average_rating,
"url": get_lms_link_for_item(block.location),
Expand Down

0 comments on commit f710dd0

Please sign in to comment.