docs: Add How-To on embedding iframes in the new Text Editor

openedx · Jun 22, 2024 · 24f8f69 · 24f8f69
1 parent fad5625
commit 24f8f69
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 1 deletion.
diff --git a/source/_images/educator_how_tos/text_editor_embedded_iframe.png b/source/_images/educator_how_tos/text_editor_embedded_iframe.png
diff --git a/source/_images/educator_how_tos/text_editor_insert_iframe.png b/source/_images/educator_how_tos/text_editor_insert_iframe.png
diff --git a/source/_images/educator_how_tos/texteditor_embed_button.png b/source/_images/educator_how_tos/texteditor_embed_button.png
diff --git a/source/community/release_notes/redwood/potpourri.rst b/source/community/release_notes/redwood/potpourri.rst
@@ -31,7 +31,8 @@ Course authors can now embed iframes into the Text Editor, making it easier to
 enrich the course experience with third-party content, without having students
 navigate away from the course.
 
-For more details on how to use this feature, see the How-to Guide. 
+For more details on how to use this feature, see
+:doc:`/educators/how-tos/embed_iframe_text_editor`.
 
 This feature is turned on by default in the Text Editor.
 

diff --git a/source/educators/how-tos/embed_iframe_text_editor.rst b/source/educators/how-tos/embed_iframe_text_editor.rst
@@ -0,0 +1,20 @@
+Embed an iframe in the Text Editor
+##################################
+
+This How-To assumes you are working with the latest version of the Text Editor,
+in the Redwood release and later.
+
+#. Visit the Text Editor in Studio.
+
+#. Click on the :guilabel:`Embed iframe` button in the top bar:
+
+     .. image:: /_images/educator_how_tos/texteditor_embed_button.png
+
+#. When you click, a modal will appear. Enter the url and size of the iframe:
+
+     .. image:: /_images/educator_how_tos/text_editor_insert_iframe.png
+
+#. Clicking on save will render the iframe:
+
+     .. image:: /_images/educator_how_tos/text_editor_embedded_iframe.png
+
diff --git a/source/educators/how-tos/index.rst b/source/educators/how-tos/index.rst
@@ -48,6 +48,7 @@ Educators: How-tos
 
          add_written_content
          add_image
+         embed_iframe_text_editor
          add_content_iframe
          copy_paste_course_content
          copy_paste_units