Skip to content

Commit 2cf6edc

Browse files
sarinasarina
committed
Update OLX Documentation (#999)
* Add diataxis tags to OLX pages * Add maintenance tables to OLX docs * Add failures to maintenance tables * Remove OLX docs that weren't written * Fix build errors * Add Maintenance Chart header * Add seealso tables for OLX pages * Move congrats message before seealso table
1 parent 201611a commit 2cf6edc

30 files changed

+608
-60
lines changed

‎source/educators/navigation/content_creation_management.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ Control Content Visibility & Access
7878
../references/controlling_content_visibility.rst
7979
../how-tos/configure_prerequisite_content.rst
8080

81+
.. _Add Course Assets:
82+
8183
Add Course Assets
8284
*******************************************************
8385

‎source/educators/navigation/olx.rst

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -209,15 +209,3 @@ Example of OLX for a Studio Course
209209
../olx/studio-example/index.rst
210210
../olx/studio-example/manual-testing-structure.rst
211211

212-
.. _OLX Open Learning XML Uses:
213-
214-
Open Learning XML Uses
215-
*******************************************************
216-
217-
.. toctree::
218-
:maxdepth: 1
219-
:glob:
220-
221-
../olx/tasks/olx-studio.rst
222-
../olx/tasks/deploy-lms.rst
223-
../olx/tasks/convert-to-olx.rst

‎source/educators/olx/about/overview.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _Course Overview:
22

33
#################################
4-
Course Overview
4+
Create Course Overview in OLX
55
#################################
66

7+
.. tags:: educator, how-to
8+
79
Each course must have an overview page. Learners see the overview page when
810
searching and registering for the course.
911

@@ -87,3 +89,23 @@ Replace the placeholders in the following template with your information.
8789
</article>
8890
</section>
8991
</section>
92+
93+
.. seealso::
94+
95+
:ref:`What is Open Learning XML?` (concept)
96+
97+
:ref:`Example of an OLX Course` (reference)
98+
99+
:ref:`Getting Started with OLX` (quickstart)
100+
101+
:ref:`OLX Directory Structure` (reference)
102+
103+
:ref:`Example of OLX for a Studio Course` (reference)
104+
105+
**Maintenance chart**
106+
107+
+--------------+-------------------------------+----------------+--------------------------------+
108+
| Review Date | Working Group Reviewer | Release |Test situation |
109+
+--------------+-------------------------------+----------------+--------------------------------+
110+
| | | | |
111+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/about/short-description.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _Short Description:
22

33
#################################
4-
Short Description
4+
Create Short Description in OLX
55
#################################
66

7+
.. tags:: educator, how-to
8+
79
Optionally, you can define a short description for your course.
810

911
Learners see the short description when they move their cursors over the course
@@ -20,3 +22,23 @@ The short description is limited to 150 characters.
2022

2123
Within that limit, you can add any text and HTML markup to the short
2224
description file.
25+
26+
.. seealso::
27+
28+
:ref:`What is Open Learning XML?` (concept)
29+
30+
:ref:`Example of an OLX Course` (reference)
31+
32+
:ref:`Getting Started with OLX` (quickstart)
33+
34+
:ref:`OLX Directory Structure` (reference)
35+
36+
:ref:`Example of OLX for a Studio Course` (reference)
37+
38+
**Maintenance chart**
39+
40+
+--------------+-------------------------------+----------------+--------------------------------+
41+
| Review Date | Working Group Reviewer | Release |Test situation |
42+
+--------------+-------------------------------+----------------+--------------------------------+
43+
| | | | |
44+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/assets/assets.rst

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,40 @@
11
.. _Course Assets:
22

33
#################################
4-
Course Assets
4+
Create Course Assets in OLX
55
#################################
66

7+
.. tags:: educator, how-to
8+
79
You must put all assets, or files that support your course, in the ``static``
810
directory. Assets include any image files, textbooks, handouts, and supporting
911
JavaScript files.
1012

1113
You must also define the asset in the assets policy file. For more information,
1214
see :ref:`Course Asset Policy`.
15+
16+
.. seealso::
17+
18+
:ref:`Add Course Assets` (reference)
19+
20+
:ref:`Course Asset Policy` (reference)
21+
22+
:ref:`What is Open Learning XML?` (concept)
23+
24+
:ref:`Example of an OLX Course` (reference)
25+
26+
:ref:`Getting Started with OLX` (quickstart)
27+
28+
:ref:`OLX Directory Structure` (reference)
29+
30+
:ref:`Example of OLX for a Studio Course` (reference)
31+
32+
33+
34+
**Maintenance chart**
35+
36+
+--------------+-------------------------------+----------------+--------------------------------+
37+
| Review Date | Working Group Reviewer | Release |Test situation |
38+
+--------------+-------------------------------+----------------+--------------------------------+
39+
| | | | |
40+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/components/discussion-components.rst

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
.. _Discussion Components:
22

33
#################################
4-
Discussion Components
4+
Discussion Components in OLX
55
#################################
66

7-
You can add inline discussion components to any container in your
7+
.. tags:: educator, reference
8+
9+
.. warning:: This page refers to the older discussion forums (pre-Olive release) and may be out of date.
10+
11+
You can add inline :term:`Discussion` components to any container in your
812
course.
913

1014
.. contents::
@@ -113,3 +117,25 @@ The following example shows an XML file for a discussion component.
113117
discussion_target="Peer Grading"
114118
display_name="Peer Grading"
115119
/>
120+
121+
.. seealso::
122+
123+
:ref:`What is Open Learning XML?` (concept)
124+
125+
:ref:`About Course Discussions` (concept)
126+
127+
:ref:`Example of an OLX Course` (reference)
128+
129+
:ref:`Getting Started with OLX` (quickstart)
130+
131+
:ref:`OLX Directory Structure` (reference)
132+
133+
:ref:`Example of OLX for a Studio Course` (reference)
134+
135+
**Maintenance chart**
136+
137+
+--------------+-------------------------------+----------------+--------------------------------+
138+
| Review Date | Working Group Reviewer | Release |Test situation |
139+
+--------------+-------------------------------+----------------+--------------------------------+
140+
| | | | |
141+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/components/html-components.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _HTML Components:
22

33
#################################
4-
HTML Components
4+
HTML Components in OLX
55
#################################
66

7+
.. tags:: educator, reference
8+
79
.. contents::
810
:local:
911
:depth: 1
@@ -115,3 +117,25 @@ file for the edX Demo course:
115117
&nbsp;They&rsquo;re fun to play with. &nbsp;Many courses will have tools
116118
and labs that you need to use to complete homework assignments.</p>
117119

120+
121+
.. seealso::
122+
123+
:ref:`What is Open Learning XML?` (concept)
124+
125+
:ref:`About Text Components` (concept)
126+
127+
:ref:`Example of an OLX Course` (reference)
128+
129+
:ref:`Getting Started with OLX` (quickstart)
130+
131+
:ref:`OLX Directory Structure` (reference)
132+
133+
:ref:`Example of OLX for a Studio Course` (reference)
134+
135+
**Maintenance chart**
136+
137+
+--------------+-------------------------------+----------------+--------------------------------+
138+
| Review Date | Working Group Reviewer | Release |Test situation |
139+
+--------------+-------------------------------+----------------+--------------------------------+
140+
| | | | |
141+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/components/problem-components.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _Problem Components:
22

33
#################################
4-
Problem Components
4+
Problem Components in OLX
55
#################################
66

7+
.. tags:: educator, reference
8+
79
The problem component allows you to add interactive exercises to the verticals
810
in your course. You can add many different types of exercises and problems.
911
This section covers the basics of problem components: what they look like to
@@ -315,3 +317,25 @@ content libraries. For more information, see
315317
.. include:: /educators/references/course_development/adding_tooltips.rst
316318
:start-after: .. START ADDING TOOLTIPS
317319
:end-before: .. END ADDING TOOLTIPS
320+
321+
.. seealso::
322+
323+
:ref:`What is Open Learning XML?` (concept)
324+
325+
:ref:`Components and Activities TOC` (reference)
326+
327+
:ref:`Example of an OLX Course` (reference)
328+
329+
:ref:`Getting Started with OLX` (quickstart)
330+
331+
:ref:`OLX Directory Structure` (reference)
332+
333+
:ref:`Example of OLX for a Studio Course` (reference)
334+
335+
**Maintenance chart**
336+
337+
+--------------+-------------------------------+----------------+--------------------------------+
338+
| Review Date | Working Group Reviewer | Release |Test situation |
339+
+--------------+-------------------------------+----------------+--------------------------------+
340+
| | | | |
341+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/components/video-components.rst

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
.. _Video Components:
22

33
#################################
4-
Video Components
4+
Video Components in OLX
55
#################################
66

7+
.. tags:: educator, reference
8+
79
You can add video components to any container in your course (such as
810
a vertical or sequential). Studio places all video components inside
911
verticals (which it calls units).
@@ -131,3 +133,27 @@ The following example shows an XML file for a video component.
131133
132134
<source src="https://s3.amazonaws.com/edx-course-videos/mit-6002x/6002-Tutorial-00010_100.mov"/>
133135
</video>
136+
137+
138+
.. seealso::
139+
140+
:ref:`What is Open Learning XML?` (concept)
141+
142+
:ref:`Add Video Components` (reference)
143+
144+
:ref:`Example of an OLX Course` (reference)
145+
146+
:ref:`Getting Started with OLX` (quickstart)
147+
148+
:ref:`OLX Directory Structure` (reference)
149+
150+
:ref:`Example of OLX for a Studio Course` (reference)
151+
152+
153+
**Maintenance chart**
154+
155+
+--------------+-------------------------------+----------------+--------------------------------+
156+
| Review Date | Working Group Reviewer | Release |Test situation |
157+
+--------------+-------------------------------+----------------+--------------------------------+
158+
| | | | |
159+
+--------------+-------------------------------+----------------+--------------------------------+

‎source/educators/olx/content-experiments/content_experiments_test_olx.rst

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,34 @@
33
.. _Test Content Experiments_OLX:
44

55
##########################################
6-
Test Content Experiments
6+
Test Content Experiments in OLX
77
##########################################
88

9+
.. tags:: educator, how-to
10+
911
You should test content experiments in your course before the course starts, to
1012
ensure that content is delivered to experiment groups as you intended.
1113

1214
For more information, see :ref:`Test Content Experiments`.
15+
16+
.. seealso::
17+
18+
:ref:`What is Open Learning XML?` (concept)
19+
20+
:ref:`Test Content Experiments` (how-to)
21+
22+
:ref:`Example of an OLX Course` (reference)
23+
24+
:ref:`Getting Started with OLX` (quickstart)
25+
26+
:ref:`OLX Directory Structure` (reference)
27+
28+
:ref:`Example of OLX for a Studio Course` (reference)
29+
30+
**Maintenance chart**
31+
32+
+--------------+-------------------------------+----------------+--------------------------------+
33+
| Review Date | Working Group Reviewer | Release |Test situation |
34+
+--------------+-------------------------------+----------------+--------------------------------+
35+
| | | | |
36+
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)