docs: add TextEditor ADR#1131
Conversation
|
✔️ Deploy Preview for paragon-edx ready! 🔨 Explore the source changes: 065ece6 🔍 Inspect the deploy log: https://app.netlify.com/sites/paragon-edx/deploys/622e7cc99a5de7000824b975 😎 Browse the preview: https://deploy-preview-1131--paragon-edx.netlify.app |
|
✔️ Deploy Preview for paragon-openedx ready! 🔨 Explore the source changes: 065ece6 🔍 Inspect the deploy log: https://app.netlify.com/sites/paragon-openedx/deploys/622e7cc95da0920008e031e9 😎 Browse the preview: https://deploy-preview-1131--paragon-openedx.netlify.app |
Codecov Report
@@ Coverage Diff @@
## master #1131 +/- ##
==========================================
+ Coverage 90.59% 90.64% +0.04%
==========================================
Files 190 191 +1
Lines 2989 3013 +24
Branches 657 666 +9
==========================================
+ Hits 2708 2731 +23
- Misses 268 269 +1
Partials 13 13
Continue to review full report at Codecov.
|
| Proposed | ||
| Context | ||
| ------- | ||
| Already, there are two simultaneous ongoing implementations of React-based html editors using tinyMCE. One is the Text Xblock editor, the other is the instructor bulk email tool found in the communications MFE. Already, edX also uses tinyMCE in edx-platform, and hosts its own image of the service there. Presumably, this experience too will be moved from the ball of mud into an independent MFE, and other use cases for text editing will arise. Therefore, it seems obvious to standardize across implementations. |
There was a problem hiding this comment.
Make that three :-) The discussions MFE also uses it for post editing: https://github.com/openedx/frontend-app-discussions/blob/master/src/components/TinyMCEEditor.jsx
adamstankiewicz
left a comment
adamstankiewicz
left a comment
There was a problem hiding this comment.
LGTM with a couple nits. Feel free to change the status to "Approved" before you merge.
|
I believe this makes sense in the long term, but for the short-term, the team needs w/rt the tinyMCE installation are going to leave them with a much less configurable option than we would want for Paragon consumption, and the TnL squad will not have the bandwidth to continue pressing on this from a component standardization perspective, so that work will need to get forwarded to the FWG or PWG for future ownership. |
|
Following up on the previous offline discussions in Frontend/Paragon Working Groups, we decided we'd defer on considering a That said, it may be interesting if Paragon one day supported its own custom text editor component that didn't rely on TinyMCE, but instead something like https://github.com/facebook/lexical. As a result, I'm inclined to close the PR for now, though we'll definitely be considering whether a text editor makes sense on the long term roadmap for Paragon. @connorhaugh If you disagree, please feel to re-open the issue 😄 Thanks! |
4 participants
This ADR proposes a Paragon TextEditor component as a pass through of Tinymce, an existing WYSIWIG text editor, with standardization. This follows the suggested reverse process for engineers to submit things to pwg