Hackathon Docs Fixes 2

source/educators/how-tos/course_development/configure_discussion_legacy.rst

@@ -5,7 +5,7 @@ Configure Open edX Discussions - Legacy
 
 .. tags:: educator, how-to
 
-.. note:: This is the legacy way to create a discussion component (for installations running the Palm or earlier releases; the new method was released in Quince, December 2023). View the latest way to create a discussion component in :ref:`Configure Open edX Discussions`.
+.. warning:: This is the legacy way to create a discussion component (for installations running the Palm or earlier releases; the new method was released in Quince, December 2023). View the latest way to create a discussion component in :ref:`Configure Open edX Discussions`.
 
 You can add discussion components to a unit to pose questions about other
 components, such as videos or text, in the unit. A discussion component gives
@@ -103,5 +103,9 @@ Create a Discussion Component
 +--------------+-------------------------------+----------------+--------------------------------------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                                                |
 +--------------+-------------------------------+----------------+--------------------------------------------------------------+
+| 2025-04-13   | sarina                        | Sumac          | Since these instructions are for pre-Quince instances, they  |
+|              |                               |                | will always fail on Quince and later releases.               |
+|              |                               |                | No further review of this page is needed moving forward.     |
++--------------+-------------------------------+----------------+--------------------------------------------------------------+
 | 03/17/2025   | Leira (Curricu.me)            | Sumac          | Fail (https://github.com/openedx/docs.openedx.org/issues/907)|
 +--------------+-------------------------------+----------------+--------------------------------------------------------------+

source/educators/how-tos/course_development/enable_notes.rst

@@ -5,6 +5,11 @@ Enabling the Notes Application
 
 .. tags:: educator, how-to
 
+.. admonition:: Install the Notes Application
+
+   In order for the Notes Application to work, it must be installed on your Open edX instance.
+   Please contact your site administrator to enable the `Notes Tutor Plugin <https://github.com/overhangio/tutor-notes>`_.
+
 The notes application can be optionally enabled to allow learners to easily create organized
 text notes for any text, problem, or video transcript content within a course. These notes are
 then centrally stored for review in the Notes area of the course
@@ -17,10 +22,15 @@ To disable or enable the Notes application, follow these steps.
 
 #. From the **Configure notes** modal, select the toggle to enable or disable the notes application.
 
-#. Select **Apply** to save your configuration changes.
+   .. image:: /_images/educator_how_tos/enable_notes.png
+     :width: 500
+     :alt: The Configure Notes modal
+
+#. Select **Save** to save your configuration changes.
 
 .. seealso::
 
+ :ref:`Notes Tool` (how-to)
 
  :ref:`Adding Pages to a Course` (how to)
 
@@ -46,5 +56,5 @@ To disable or enable the Notes application, follow these steps.
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-|              |                               |                |                                |
+| 2024-04-14   | sarina                        | Sumac          | Pass                           |
 +--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/exercise_tools/create_problem_in_latex.rst

@@ -5,47 +5,7 @@ Problem Written in LaTeX
 
 .. tags:: educator, how-to
 
-.. warning:: This problem type is a prototype, and is not supported. By
- default, the ability to create these problems is not enabled in Studio. You
- must change the advanced settings in your course before you can create
- problems with LaTeX. Use this problem type with caution.
-
-If you have an problem that is already written in LaTeX, you can use this
-problem type to easily convert your code into XML. After you paste your code
-into the LaTeX editor, you make a few adjustments.
-
-.. note:: If you want to use LaTeX to typeset mathematical expressions
-          in problems that you haven't yet written, use any of the other
-          problem templates together with `MathJax <http://www.mathjax.org>`_.
-          For more information about how to create mathematical expressions in
-          Studio using MathJax, see :ref:`MathJax in Studio`.
-
-.. image:: /_images/educator_how_tos/ProblemWrittenInLaTeX.png
- :alt: Image of a problem written in LaTeX
-
-Create a Problem Written in LaTeX
-*********************************
-
-To create a problem written in LaTeX, follow these steps.
-
-#. Enable the policy key in your course.
-
-   #. In Studio, click **Settings**, and then click **Advanced Settings**.
-   #. In the field for the **Enable LaTeX Compiler** policy key, change
-      **false** to **true**.
-   #. At the bottom of the page, click **Save Changes**.
-
-#. In the unit where you want to create the problem, click **Problem**
-   under **Add New Component**, and then click the **Advanced** tab.
-#. Click **Problem Written in LaTeX**.
-#. In the component editor that appears, click **Edit**.
-#. In the lower left corner of the component editor, click **Launch
-   LaTeX Source Compiler**.
-#. Replace the example code with your own code. You can also upload a Latex
-   file into the editor from your computer by clicking **Upload** in the bottom
-   right corner.
-#. In the lower left corner of the LaTeX source compiler, click **Save &
-   Compile to Open edX XML**.
+.. warning:: LaTeX editor support was removed with the rollout of the new Course Authoring-based Text Editor in the Redwood release.
 
 .. seealso::
 
@@ -58,8 +18,6 @@ To create a problem written in LaTeX, follow these steps.
 
  :ref:`Award Partial Credit in a Numerical Input Problem` (how-to)
 
- :ref:`Work with Latex Code` (how-to)
-
  :ref:`Manage Numerical Input Problem` (how-to)
 
 
@@ -68,5 +26,5 @@ To create a problem written in LaTeX, follow these steps.
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-|              |                               |                |                                |
+| 2025-04-1    | sarina                        | Sumac          | Pass                           |
 +--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/exercise_tools/enable_notes.rst

@@ -1,6 +1,6 @@
 .. _Notes Tool:
 
-Enable the Notes Tool
+About the Notes Tool
 #####################
 
 .. tags:: educator, how-to
@@ -29,16 +29,27 @@ of the notes in the course body.
 You must enable the Notes tool before learners can use it. To enable the Notes
 tool, follow these steps.
 
+.. admonition:: Install the Notes Application
+
+   In order for the Notes Application to work, it must be installed on your Open edX instance.
+   Please contact your site administrator to enable the `Notes Tutor Plugin <https://github.com/overhangio/tutor-notes>`_.
+   See :ref:`Enable Notes` for more details.
+
 #. In Studio, from the **Content** menu select **Pages & Resources**.
 
 #. Click the gear icon on the **Notes** card shown on this page.
 
 #. From the **Configure notes** modal, select the toggle to enable or disable the notes application.
 
-#. Select **Apply** to save your configuration changes.
+   .. image:: /_images/educator_how_tos/enable_notes.png
+     :width: 500
+     :alt: The Configure Notes modal
+
+#. Select **Save** to save your configuration changes.
 
 .. seealso::
-
+
+ :ref:`Enable Notes` (how-to)
 
  :ref:`RecommenderXBlock` (how-to)
 
@@ -54,5 +65,5 @@ tool, follow these steps.
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-|              |                               |                |                                |
+| 2024-04-14   | sarina                        | Sumac          | Pass                           |
 +--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/exercise_tools/manage_full_screen_image.rst

@@ -91,8 +91,6 @@ Create a Full Screen Image
 
  :ref:`Work with HTML code` (how-to)
 
- :ref:`Work with Latex Code` (how-to)
-
 
 **Maintenance chart**
 

source/educators/how-tos/course_development/manage_units.rst

@@ -205,7 +205,7 @@ To publish the unit, select **Publish** in the status panel.
 Use the Outline to Publish a Unit
 =======================================
 
-To publish a unit from the outline, select the **Publish** option from the kebab menu
+To publish a unit from the outline, select the **Publish** option from the kebab (3-dot) menu
 of the unit.
 
 .. image:: /_images/educator_how_tos/outline-publish-icon-unit.png
@@ -226,6 +226,10 @@ changes so that Studio reverts to the last published version of the unit.
 To discard changes and revert the Studio version of the unit to the last
 published version, select **Discard Changes** in the status panel.
 
+.. image:: /_images/educator_how_tos/discard_draft_changes.png
+   :width: 300
+   :alt: The Course Outline page the publish option highlighted for a unit.
+
 .. caution::
  When you discard changes to a unit, the changes are permanently deleted. You
  cannot retrieve discarded changes or undo the action.
@@ -283,5 +287,5 @@ Course Content`.
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-| 03/19/2025   | John (Curricu.me)             | Sumac          | Pass                           |
+| 2025-03-19   | John (Curricu.me)             | Sumac          | Pass                           |
 +--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/text_components/manage_html.rst

@@ -72,8 +72,6 @@ the HTML content in your course.
 
  :ref:`Manage the Full Screen Image Tool` (how-to)
 
- :ref:`Work with Latex Code` (how-to)
-
 
 **Maintenance chart**
 

source/educators/how-tos/course_development/text_components/manage_latex.rst

@@ -5,78 +5,7 @@ Work with LaTeX Code
 
 .. tags:: educator, how-to
 
-.. note:: LaTeX editor support was removed with the rollout of the new Course Authoring-based Text Editor in the Redwood release.
-
-
-.. ==========================
-.. Enable the LaTeX Processor
-.. ==========================
-
-.. The LaTeX processor is not enabled by default. To enable it, you have to change
-.. the advanced settings in your course.
-
-.. #. In Studio, select **Settings**, and then select **Advanced Settings**.
-
-.. #. In the field for the **Enable LaTeX Compiler** policy key, change **false**
-   to **true**.
-
-.. #. At the bottom of the page, select **Save Changes**.
-
-.. ==============================================
-.. Add a Text Component that Contains LaTeX Code
-.. ==============================================
-
-.. When the LaTeX processor is enabled, you can create a Text component that
-.. contains LaTeX code.
-
-.. #. In the unit where you want to create the component, select **Text** under
-   **Add New Component**, and then select **E-text Written in LaTeX**. The new
-   component is added to the unit.
-
-.. #. Select **Edit** to open the new component.
-
-.. #. At the bottom of the component editor, select **Launch Latex Source
-   Compiler**.
-
-   The LaTeX editor opens.
-
-   .. image:: /_images/educator_how_tos/HTML_LaTeXEditor.png
-    :alt: The LaTeX editor.
-    :width: 500
-
-.. #. Add your LaTeX code. To do this, complete either of the following
-   procedures.
-
-   * In the **High Level Source Editing** field, add your LaTeX code.
-
-   * To upload a LaTeX file from your computer, select **Upload**.
-
-.. #. Select **Save & Compile to edX XML**.
-
-.. #. On the unit page, select **Preview** to verify that your content looks
-   correct in the LMS.
-
-   If you see errors, go back to the unit page. Select **Edit** to open the
-   component again, and then select **Launch Latex Source Compiler** to edit
-   the LaTeX code.
-
-.. _import latex code:
-
-.. ****************************************
-.. Import LaTeX Code into a Text Component
-.. ****************************************
-
-.. You can import LaTeX code into a Text component. You might do this, for
-.. example, if you want to create "beautiful math" such as the math in the
-.. following image.
-
-.. .. image:: /_images/educator_how_tos/HTML_LaTeX_LMS.png
-.. :alt: Math formulas created with LaTeX in a Text component.
-
-.. .. warning::
-..    The LaTeX processor that Studio uses to convert LaTeX code to XML is a third
-..    party tool. We recommend  you use this feature with caution. If you use
-..    the tool, make sure you work with your partner manager.
+.. warning:: LaTeX editor support was removed with the rollout of the new Course Authoring-based Text Editor in the Redwood release.
 
 .. seealso:: 
 
@@ -95,5 +24,5 @@ Work with LaTeX Code
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-|              |                               |                |                                |
+| 2025-04-13   |  sarina                       |   Sumac        |  Pass                          |
 +--------------+-------------------------------+----------------+--------------------------------+

source/educators/how-tos/course_development/text_components/manage_text.rst

@@ -45,7 +45,6 @@ When you use the visual editor, you can also perform the following tasks.
 
 * :ref:`Add a Link in a Text Component`
 * :ref:`Add an Image to a Text Component`
-* :ref:`Import LaTeX Code<import latex code>`
 
 .. _Add an Image to a Text Component:
 
@@ -412,8 +411,6 @@ Visual and Raw editor types once selected.
 
  :ref:`Manage the Full Screen Image Tool` (how-to)
 
- :ref:`Work with Latex Code` (how-to)
-
 
 **Maintenance chart**
 

source/educators/how-tos/releasing-course/manage_beta_testing.rst

@@ -43,7 +43,7 @@ When you add beta testers, note the following.
 
 * If the beta test starts before the course **Enrollment Start Date**, testers
   cannot enroll themselves in your course. However, you can enroll the beta
-  testers prior to the **Enrollment Start Date**.
+  testers prior to the **Enrollment Start Date**. See :ref:`Enroll Learners in a Course`.
 
 * If you add the beta testers after the defined start of the beta test, and
   they are enrolled in the course, they see your course on their **Current
@@ -58,13 +58,17 @@ When you add beta testers, note the following.
 Add or Remove Individual Beta Testers
 ===============================================
 
+.. note::  If the beta test starts before the **Enrollment Start Date** of your
+   course, you must also :ref:`manually enroll the beta tester<Enroll Learners in a Course>`.
 
-#. View the live version of the course.
+#. :ref:`View the live version of your course<View Published Content>`.
 
 #. Select **Instructor**, and then select **Membership**.
 
 #. In the **Course Team Management** section, select **Beta Testers**.
 
+   .. image:: /_images/educator_how_tos/individual_beta_enrollment.png
+
 #. Under the list of users who currently have that role, enter the email address
    or username of the person you want to add.
 
@@ -73,14 +77,13 @@ Add or Remove Individual Beta Testers
    The person who you added appears in the list of beta testers.
 
 
-.. note::  If the beta test starts before the **Enrollment Start Date** of your
-   course, you can also enroll the beta tester. See :ref:`Enrollment`.
-
-
 To remove the Beta Tester role from users individually, find the user in the
 list of beta testers, and then select **Revoke access** to the right of that
 user's email address.
 
+.. image:: /_images/educator_how_tos/individual_beta_unenrollment.png
+
+
 .. _Add_Testers_Bulk:
 
 =======================================
@@ -95,14 +98,16 @@ beta testers that they have been added.
 
 To add multiple beta testers:
 
-#. View the live version of your course.
+#. :ref:`View the live version of your course<View Published Content>`.
 
 #. Select **Instructor**, and then select **Membership**.
 
 #. In the **Batch Beta Tester Addition** section of the page, enter one or more
    addresses or usernames separated by commas or line feeds (the Enter key).
    You can also copy data from a CSV file of email addresses and paste it here.
 
+   .. image:: /_images/educator_how_tos/batch_beta_enrollment_instructor_dash.png
+
 #. To enroll the beta testers in your course, leave **Auto Enroll** selected.
    If the beta test starts before the course **Enrollment Start Date**, testers
    cannot enroll themselves in your course.
@@ -147,5 +152,5 @@ problems, questions, and issues can occur while a course is running.
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-|              |                               |                |                                |
+| 2025-04-13   | sarina                        | Sumac          |  Pass                          |
 +--------------+-------------------------------+----------------+--------------------------------+