Repository navigation
Consolidate Optional XBlocks #317
Description
Preliminary list:
- openedx/AudioXBlock
- openedx/ConceptXBlock
- openedx/schoolyourself-xblock
- openedx/xblock-image-modal
- openedx/xblock-qualtrics-survey
- openedx/xblock-sql-grader
- openedx/xblock-submit-and-compare
- openedx/FeedbackXBlock
- openedx/DoneXBlock
- openedx/RecommenderXBlock
Other blocks, TBD
High-usage
- openedx/xblock-drag-and-drop-v2
- mitodl/edx-sga
- open-craft/xblock-poll
Not sure
- openedx/xblock-google-drive
- openedx/xblock-image-explorer
- openedx/xblock-in-video-quiz
Questions
- what's the criteria for extra (versus xblocks-contrib)?
- which of these are installed by default?
Linked Parent Story: openedx/openedx-platform#34827
Metadata
Metadata
Assignees
Type
Projects
- Status
Activity
farhan commentedon Mar 6, 2025
We have created following document
@feanil @kdmccormick Please fill the usage data for example (High, Medium, Low, No)
https://docs.google.com/spreadsheets/d/1n1PYV1wnHPRYCObJ_mrWhgJttd3pZULEU5uAV8ACciE/edit?usp=sharing
We have classiffied the XBlocks in this way so far:
xblocks-contrib: Core XBlocks
- word-cloud
- annotatable
- html
- ...
xblocks-extras: XBlocks not installed by default in platform [Can further classify based on usage and list size]
- feedback-xblock
- AudioXBlock
- ConceptXBlock
- schoolyourself-xblock
- xblock-image-modal
- xblock-qualtrics-survey
- xblock-sql-grader
- xblock-submit-and-compare
xblocks-extras-reloadedxblocks-extras-2: XBlocks installed by default in platform. There are some major xblocks in it that deserve to stay in separate repository alone.- ora2
- acid-xblock
- lti-consumer-xblock
- crowdsourcehinter-xblock
- done-xblock
- recommender-xblock
- staff-graded-xblock
- xblock-poll
- xblock-drag-and-drop-v2
- xblock-google-drive
[-]Collect low-usage blocks into xblocks-extra[/-][+]Let's Classify XBlocks[/+]farhan commentedon Apr 3, 2025
As per weekly discussion with the client on 26th Mar, 2025 we decided:
ora2,lti-consumer-xblock,xblock-google-drivestandalone in the repos as they have large code base and quality to stay separate.xblocks-extrasmentioned above as they are smaller xblocks.cc: @kdmccormick @openedx/axim-aximprovements
kdmccormick commentedon Apr 9, 2025
The plan for xblocks-contrib (installed by default) and xblocks-extras (not installed by default) looks good to me.
@farhan could you explain xblocks-extras-reloaded? I understand that some of them (e.g.
ora2) will remain separate. What about the others? Could they be merged into xblocks-contrib as well, or do you see a need for another bundle?farhan commentedon Apr 9, 2025
@kdmccormick
xblocks-extras-reloadedis not a real name, I just gave any other name for now :)We will have another brainstorming session on the compilation of leftover xblocks and their grouping.
cc: @openedx/axim-aximprovements
farhan commentedon Apr 10, 2025
@hinakhadim will be working further on this as an open source contributor, we had a discussion on it and explained the task
Here are the useful links:
https://github.com/openedx/xblocks-contrib [Consolidated repo as a sample architecture]
https://docs.google.com/spreadsheets/d/1rMwbRldYwp-xPsAG2vijqwB__9M7P2AgjDxX31G7ucA/edit?gid=0#gid=0
hinakhadim commentedon Apr 15, 2025
Hey @kdmccormick @feanil, would you mind creating the
xblocks-extrasrepository and adding me as a maintainer inxblock-extrasrepository? I don't have access to create it.kdmccormick commentedon Apr 15, 2025
Hi @hinakhadim , please create a New Issue here, and use the GH Access/Config template: https://github.com/openedx/axim-engineering/issues. That way we'll have a record of why the repo was created. Tag Feanil and I on the issue, and we'll get the repo created for you shortly.
hinakhadim commentedon Apr 15, 2025
Hey @kdmccormick, I’ve opened the request here: openedx/axim-engineering#1443
Appreciate your help in getting the
xblocks-extrasrepo created and granting me maintainer access. Let me know if anything else is needed!e0d commentedon Sep 19, 2025
Should we consider pulling this in https://github.com/raccoongang/xblock-pdf. It's used by a fair number of folks.
25 remaining items
FuaadZam commentedon Apr 28, 2026
This Block is pending
xblocks-extras-2: XBlocks installed by default in platform. There are some major xblocks in it that deserve to stay in separate repository alone.
xblocks-extraxblocks-extra#34feanil commentedon May 5, 2026
If we do want these to continue to be installed by default for the smaller ones, it may make sense to just pull them into xblocks-core (previosly xblocks-contrib) and then for any that are large or have their own database models, I think we should leave them as separate repositories/django apps since moving django apps can be complex and not usually worth the pain. What do you thin @kdmccormick
kdmccormick commentedon May 5, 2026
Renaming django apps or moving models between apps is painful. Moving models across repos without renaming the app is fine.
That said, I agree with the general approach of:
Hammadahmad2 commentedon Oct 30, 2026
@farhan , need to review this as discussed in the meeting
feanil commentedon Oct 30, 2026
I think we've done the portion of this that has the most value, which is taking the smaller blocks with no maintainers and consolidating them. The next set mostly has maintainers and there would be less value in consolidating it for now.