Deprecation/Removal: Text Editor in edx-platform #34692

Hi there,

We plan to deprecate and remove the edx-platform text editor and replace it with the course authoring text editor.

Please read openedx/edx-platform issue #34692 for more information and to post any questions/comments. The proposed deadline for comments before acceptance is 2024-05-17.

Once the ticket is accepted, removal can happen at any time. If you believe that the edx-platform Text Editor has cases that are not covered by the course authoring Text Editor and wish to make a case for retaining it and taking over its maintainership, please speak up on the issue linked above. It should be noted that the edx-platform Text Editor will no longer be able to support edit images because the repo that contains the EditImageModal is marked for deprecation and will be removed in the Sumac release.

After acceptance, all future notifications around removal will only be posted to the GitHub issue, so be sure to watch that issue if you want further updates.

Thanks, Kristin Aoki

@Kristin_Aoki, I don’t see this mentioned anywhere, so I just wanted to note that the text editor is also used on the /maintenance/announcements/create page in Studio.

Also, what will happen to the XBlocks that specify multiline_editor=“html”, like edx_sga (which is currently a part of the platform requirements) or problem_builder? Will the editor no longer work with them, or can they be edited in the Course Authoring MFE?

1 Like

Thank you for flagging the use of the text editor within xblocks that are not filed under Text in Studio that is not a case that was considered. We will investigate more on a solution to using the course authoring text editor in xblocks with the multiline_editor attribute. Regarding the maintenance page, there are plans to add the page to the Course Authoring MFE and use the course authoring text editor.

1 Like

Thanks for posting this @Kristin_Aoki , and good point @Agrendalath .

Since multiline_editor=html is part of the XBlock API (via xblock.utils.studio_editable.StudioEditableXBlockMixin), I don’t think we should drop the old text editor’s ability to edit images. Unfortunately, since the image editor is part of studio-frontend, this means that studio-frontend cannot be removed until multiline_editor=html is ported to the new editor.

@Agrendalath On second thought, looking at edx-sga, which uses multiline_editor=html for the solution field, I don’t actually see an image upload option:

I could be mistaken, but I believe that this is just a tinyMCE editor rendered by JS in the xblock package, unrelated to the legacy Text editor that @Kristin_Aoki is proposing for deprecation.

Does that seem right?

@kmccormick, good catch. If it works independently, removing the legacy editor sounds reasonable.

The only note is that we should probably keep the TinyMCE as a dependency in the edx-platform (at least for now), as it’s used by the xblock-utils and ora2. We also use it in our custom HTML XBlock, but we can change it back to providing its own TinyMCE library, if needed.

cc: @Kristin_Aoki

1 Like