Skip to content

feat: add reset option to the Randomized Content Block - #29728

Merged
jristau1984 merged 1 commit into
openedx:masterfrom
open-craft:tecoholic/add_reset_to_randomized_content_block
Jun 6, 2022
Merged

feat: add reset option to the Randomized Content Block#29728
jristau1984 merged 1 commit into
openedx:masterfrom
open-craft:tecoholic/add_reset_to_randomized_content_block

Conversation

@tecoholic

Copy link
Copy Markdown
Contributor

Description

This PR supersedes the previous one at #28624

This adds a reset option to the randomized content block. This way students can prepare themselves for exams by answering a series of questions at random from a pre-determined set (something similar to flashcards).

We have been doing it with Python scripts within the CAPA blocks - questions and answers were included directly in the script and the reset button was changing the seed used for determining the question set. This PR introduces a similar functionality by using built-in Open edX features, thus making it more user-friendly and available for less technical course authoring teams.

Supporting information

Testing instructions

  • Check out to this branch tecoholic/add_reset_to_randomized_content_block on edx-platform.
  • In Studio, create a Randomized Content Block and set the Show Reset Button option to True.
  • View the live version of the new block and click on the Reset Problems button on the bottom left part of the Randomized Content Block.
  • Verify that the contents of the block are reloaded, answers are reset and the questions are changed.

Deadline

None

Other information

This feature is created with the use-case of using the Randomized Content Block as a Flash Card system for students to cycle through a prepared set of questions/problems.

@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @tecoholic! I've created OSPR-6366 to keep track of it in JIRA, where we prioritize reviews. 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.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added needs triage open-source-contribution PR author is not from Axim or 2U labels Jan 7, 2022
@natabene

Copy link
Copy Markdown
Contributor

@tecoholic Thank you for your contribution. Please let me know once this is ready for our review.

@tecoholic
tecoholic force-pushed the tecoholic/add_reset_to_randomized_content_block branch from 8c4804d to 89cb0a6 Compare January 12, 2022 13:19
@openedx-webhooks openedx-webhooks added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed needs triage labels Jan 12, 2022
@Agrendalath
Agrendalath force-pushed the tecoholic/add_reset_to_randomized_content_block branch from 89cb0a6 to 3b4f13c Compare January 14, 2022 16:31

@Agrendalath Agrendalath left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

  • I tested this: tested the RCB reset feature locally
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a
  • I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

@Agrendalath

Copy link
Copy Markdown
Member

@natabene, this is ready for your review.

@Agrendalath
Agrendalath force-pushed the tecoholic/add_reset_to_randomized_content_block branch from 3b4f13c to a3fa13f Compare May 4, 2022 12:16
@openedx-webhooks openedx-webhooks added product review PR requires product review before merging and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels May 4, 2022
@Agrendalath
Agrendalath force-pushed the tecoholic/add_reset_to_randomized_content_block branch from a3fa13f to c473b41 Compare May 10, 2022 17:12
@Agrendalath
Agrendalath force-pushed the tecoholic/add_reset_to_randomized_content_block branch 2 times, most recently from ed511c6 to e4b04c0 Compare May 21, 2022 09:13
This makes the reset button to refresh the contents of a Randomized
Content Block (RCB) without reloading the full page by fetching a new
set of problems in the "reset" response and replacing the DOM contents.

The reset button returns the student view as a string and the client
uses the HtmlUtils package to replace the contents and reinitializes the
XBlock.

This allows students to use the RCB as a flash card system.

Co-authored-by: tinumide <tinuade@opencraft.com>
@Agrendalath

Copy link
Copy Markdown
Member

@natabene, just checking on this PR.

@natabene

Copy link
Copy Markdown
Contributor

@tecoholic Sorry, no news yet.

@jristau1984

Copy link
Copy Markdown
Contributor

I confirmed the default value of this feature is "False" so it should not impact existing nor newly created libraries unless they desire to activate this button.

@jristau1984
jristau1984 merged commit d253503 into openedx:master Jun 6, 2022
@openedx-webhooks openedx-webhooks added merged and removed product review PR requires product review before merging labels Jun 6, 2022
@openedx-webhooks

Copy link
Copy Markdown

@tecoholic 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

@Agrendalath
Agrendalath deleted the tecoholic/add_reset_to_randomized_content_block branch June 6, 2022 20:17
@tecoholic

Copy link
Copy Markdown
Contributor Author

Yay! :)

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

1 similar comment
@edx-pipeline-bot

Copy link
Copy Markdown
Contributor

EdX Release Notice: This PR has been deployed to the production environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

merged 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.

6 participants