Skip to content

Commit 5d81341

Browse files
committed
Update/pass the Notes documentation
Resolves #753
1 parent b21bd55 commit 5d81341

5 files changed

Lines changed: 27 additions & 6 deletions

File tree

228 KB
Loading
-29.8 KB
Loading
223 KB
Loading

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ Enabling the Notes Application
55

66
.. tags:: educator, how-to
77

8+
.. admonition:: Install the Notes Application
9+
10+
In order for the Notes Application to work, it must be installed on your Open edX instance.
11+
Please contact your site administrator to enable the `Notes Tutor Plugin <https://github.com/overhangio/tutor-notes>`_.
12+
813
The notes application can be optionally enabled to allow learners to easily create organized
914
text notes for any text, problem, or video transcript content within a course. These notes are
1015
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.
1722

1823
#. From the **Configure notes** modal, select the toggle to enable or disable the notes application.
1924

20-
#. Select **Apply** to save your configuration changes.
25+
.. image:: /_images/educator_how_tos/enable_notes.png
26+
:width: 500
27+
:alt: The Configure Notes modal
28+
29+
#. Select **Save** to save your configuration changes.
2130

2231
.. seealso::
2332

33+
:ref:`Notes Tool` (how-to)
2434

2535
:ref:`Adding Pages to a Course` (how to)
2636

@@ -46,5 +56,5 @@ To disable or enable the Notes application, follow these steps.
4656
+--------------+-------------------------------+----------------+--------------------------------+
4757
| Review Date | Working Group Reviewer | Release |Test situation |
4858
+--------------+-------------------------------+----------------+--------------------------------+
49-
| | | | |
59+
| 2024-04-14 | sarina | Sumac | Pass |
5060
+--------------+-------------------------------+----------------+--------------------------------+

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

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _Notes Tool:
22

3-
Enable the Notes Tool
3+
About the Notes Tool
44
#####################
55

66
.. tags:: educator, how-to
@@ -29,16 +29,27 @@ of the notes in the course body.
2929
You must enable the Notes tool before learners can use it. To enable the Notes
3030
tool, follow these steps.
3131

32+
.. admonition:: Install the Notes Application
33+
34+
In order for the Notes Application to work, it must be installed on your Open edX instance.
35+
Please contact your site administrator to enable the `Notes Tutor Plugin <https://github.com/overhangio/tutor-notes>`_.
36+
See :ref:`Enable Notes` for more details.
37+
3238
#. In Studio, from the **Content** menu select **Pages & Resources**.
3339

3440
#. Click the gear icon on the **Notes** card shown on this page.
3541

3642
#. From the **Configure notes** modal, select the toggle to enable or disable the notes application.
3743

38-
#. Select **Apply** to save your configuration changes.
44+
.. image:: /_images/educator_how_tos/enable_notes.png
45+
:width: 500
46+
:alt: The Configure Notes modal
47+
48+
#. Select **Save** to save your configuration changes.
3949

4050
.. seealso::
41-
51+
52+
:ref:`Enable Notes` (how-to)
4253

4354
:ref:`RecommenderXBlock` (how-to)
4455

@@ -54,5 +65,5 @@ tool, follow these steps.
5465
+--------------+-------------------------------+----------------+--------------------------------+
5566
| Review Date | Working Group Reviewer | Release |Test situation |
5667
+--------------+-------------------------------+----------------+--------------------------------+
57-
| | | | |
68+
| 2024-04-14 | sarina | Sumac | Pass |
5869
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)