Skip to content

Conversation

@irtazaakram
Copy link
Member

@irtazaakram irtazaakram commented Jul 24, 2024

Adds annotatable xblock extracting from edx-platform repo

Test PR

Make a test PR on edx-platform like this to run test cases on under development PR.

File references:

  • xblocks_contrib/annotatable/annotatable.py has been extracted from
  • xblocks_contrib/annotatable/templates/annotatable.html has been extracted from
  • xblocks_contrib/annotatable/templates/annotatable_editor.html has been extracted from
  • xblocks_contrib/annotatable/static/js/src/annotatable.js has been extracted from
  • xblocks_contrib/annotatable/static/js/src/annotatable_editor.js has been extracted from
  • xblocks_contrib/annotatable/static/css/annotatable.css has been extracted from
  • xblocks_contrib/annotatable/static/css/annotatable_editor.css has been extracted from
  • xblocks_contrib/annotatable/tests/test_annotatable.py has been extracted from

Acceptance Criteria:

  • Extracted XBlock user experience should behave normal if required global css variables donesn't exist
  • Extracted XBlock funcationality should work fine after turning its relevant Django Settings Flag
  • In existing built in xblock implementation of edx-platform, update the status or data of the XBlocks. Then change the Django Settings flag and verify after shifting to extracted one, XBlocks are maintaining their required states (including XBlock completion status).
  • Also test the vice versa of above step, change XBlock from Extracted one to Built in implementation to check fallback case testings.
  • i18n is supported in the XBlock
  • Create a course, add multiple XBlocks in the course. Keep different XBlocks in diversity of states (done/un-done etc). Export the course then validate the XBlock states after importing it again.
  • Make a test PR for the extracted PR like this and fix the test cases if required.
  • Write further unit test cases for good code coverage

Relevant Issue: openedx/openedx-platform#34841

Base automatically changed from core-xblocks to main October 7, 2024 13:59
@irtazaakram irtazaakram marked this pull request as ready for review October 21, 2024 06:50
@irtazaakram irtazaakram requested a review from farhan October 22, 2024 07:54
@irtazaakram irtazaakram requested a review from farhan March 3, 2025 05:06
@farhan
Copy link
Contributor

farhan commented Mar 20, 2025

@irtazaakram PR looks good now. Just make sure to:

Test and verify all the tasks mentioned in the PR description.
Fix the corresponding issue in the edx-platform as well.

Copy link
Contributor

@farhan farhan left a comment

Choose a reason for hiding this comment

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

Good work ⭐

@irtazaakram irtazaakram merged commit d854144 into main Apr 14, 2025
11 of 12 checks passed
@irtazaakram irtazaakram deleted the annotatable branch April 14, 2025 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants