Let's Classify XBlocks

[kdmccormick]

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

[farhan]

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:

1. xblocks-contrib: Core XBlocks
   - word-cloud
   - annotatable
   - html
   - ...

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

3. xblocks-extras-preloaded: 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

[farhan]

As per weekly discussion with the client on 26th Mar, 2025 we decided:

1. Keep the blocks like ora2, lti-consumer-xblock, xblock-google-drive standalone in the repos as they have large code base and quality to stay separate.
2. It's fine to merge the blocks of xblocks-extras mentioned above as they are smaller xblocks.

cc: @kdmccormick @openedx/axim-aximprovements

[kdmccormick]

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]

@kdmccormick

xblocks-extras-reloaded is 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]

@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]

Hey @kdmccormick @feanil, would you mind creating the xblocks-extras repository and adding me as a maintainer in xblock-extras repository? I don't have access to create it.

[kdmccormick]

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]

Hey @kdmccormick, I’ve opened the request here: openedx/axim-engineering#1443
Appreciate your help in getting the xblocks-extras repo created and granting me maintainer access. Let me know if anything else is needed!

[e0d]

Should we consider pulling this in https://github.com/raccoongang/xblock-pdf. It's used by a fair number of folks.