Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds word cloud xblock extracting from edx-platform repo #4

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

farhan
Copy link

@farhan farhan commented Jul 12, 2024

Adds word cloud xblock extracting from edx-platform repo

Test PR

Deprecation/Test PR to install this xblock into edx-patform
You also need to update entry_point in Open_edX.egg-info/entry_points.txt
from word_cloud to word_cloud_deprecated to make it work on local setup

File references:

  • xblocks_contrib/word_cloud/word_cloud.py has been extracted from
  • xblocks_contrib/word_cloud/static/html/word_cloud_xblock.html has been extracted from
  • xblocks_contrib/word_cloud/static/js/src/word_cloud_xblock.js and other d3-cloud files has been extracted from
  • xblocks_contrib/word_cloud/static/css/word_cloud_xblock.css has been extracted from lms/static/css/WordCloudBlockDisplay.css

Pending

Managing global CSS Variables in pending:

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.
  • 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
  • All test cases listed in the description of this test PR should pass. (It's not required as above point is more suitable.)

@farhan farhan marked this pull request as ready for review July 24, 2024 14:06
@farhan farhan linked an issue Jul 25, 2024 that may be closed by this pull request
@farhan farhan force-pushed the farhan/word-cloud-xblock branch 2 times, most recently from 200a788 to 91432f2 Compare July 30, 2024 07:34
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Just a couple nits so far, but generally this is looking great. I still need to test it myself, but it's exciting to hear that you have this working in edx-platform 🔥

xblocks_contrib/word_cloud/word_cloud.py Outdated Show resolved Hide resolved
xblocks_contrib/word_cloud/word_cloud.py Outdated Show resolved Hide resolved
@kdmccormick kdmccormick self-requested a review August 20, 2024 18:24
@kdmccormick
Copy link
Member

kdmccormick commented Sep 4, 2024

I'm going to hold off on testing this for now. Let's focus on getting all the stub XBlocks into #2, getting that reviewed and merged, and then getting the waffle flags into edx-platform. That way, it will be easy to test this PR in edx-platform.

@kdmccormick kdmccormick removed their request for review September 4, 2024 18:30
Base automatically changed from core-xblocks to main October 7, 2024 13:59
@farhan farhan force-pushed the farhan/word-cloud-xblock branch 3 times, most recently from 5ed4627 to 3c289df Compare October 9, 2024 06:21
@farhan farhan force-pushed the farhan/word-cloud-xblock branch from b5b6bf9 to 24544fb Compare November 8, 2024 13:01
@farhan farhan requested a review from kdmccormick November 8, 2024 13:13
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Could you rebase this Farhan? Then I'll be happy to test this using new flag we've added to edx-platform.

@farhan
Copy link
Author

farhan commented Dec 3, 2024

@kdmccormick This PR's branch is already up-to-date with the main branch.

  • I think, we can test it on edx-platform by manually install it pip install path-to-xblocks-contrib-proj
  • I think, we can run test cases on them, after merging it, releasing a new version and then update on edx-platform`
  • I have created this Test PR on edx-platform as well

Please suggest if we have better ways to do
cc: @irtazaakram @ttqureshi

@kdmccormick
Copy link
Member

@farhan to test locally with tutor, you can mount the repo and rebuild+reboot:

tutor mounts add path/to/xblocks-contrib
tutor images build openedx-dev
tutor dev reboot

With that setup, you should be able to git switch between xblocks-contrib branches and see that the LMS and CMS containers automatically restart using branch's code.

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.

WordCloudBlock Extraction
2 participants