Skip to content

Commit 2bb2235

Browse files
committed
partial: Rewrite organizing-course documents
1 parent ce6d6c9 commit 2bb2235

File tree

3 files changed

+194
-131
lines changed

3 files changed

+194
-131
lines changed

source/educators/olx/about/overview.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ Create Course Overview in OLX
66

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

9+
.. note::
10+
11+
This page describes how to create the Course Overview section for
12+
your course, provided your Open edX instance is using the default
13+
Open edX course catalog. Your Open edX instance might utilize a different
14+
way of publishing and advertising courses.
15+
916
Each course must have an overview page. Learners see the overview page when
1017
searching and registering for the course.
1118

source/educators/olx/organizing-course/course-structure-overview.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,23 @@ Courseware is the main content of your course and consists mainly of lessons
2121
and assessments. The following list describes how courseware is organized in
2222
OLX.
2323

24-
* Course chapters are at the top level of your course and typically
25-
represent a time period. In Studio, chapters are called *sections*.
24+
* Course sections are at the top level of your course and typically
25+
represent a time period. In OLX, sections are defined in the ``chapter`` directory.
2626

27-
* A chapter contains one or more children which correspond to
28-
top-level pages in the course. In Studio, these are called 'subsections' and
29-
are currently restricted to ``sequential`` elements at this
30-
level. OLX supports any XBlock at this level.
27+
* A section contains one or more children ("subsections") which correspond to
28+
top-level pages in the course. In Studio, these
29+
are defined within ``sequential`` elements at this level.
3130

32-
* Courses are composed of structural elements, such as ``sequential``
33-
and ``vertical``, and leaf-nodes or content elements, such as
31+
.. note::
32+
33+
Technically, OLX supports any XBlock at this level. This is not
34+
guaranteed to work upon Studio import.
35+
36+
* Courses are composed of structural elements, such as ``sequential`` (subsections),
37+
``vertical`` (units), and leaf-nodes (content elements/components), such as
3438
``html`` or ``problem``. Studio has a fixed hierarchy where children
3539
of ``sequential`` elements are ``vertical`` elements (called units),
36-
and children of ``vertical`` elements are leaf elements (called modules).
40+
and children of ``vertical`` elements are leaf elements (called components).
3741

3842
* :ref:`Course Components<OLX Components>`
3943
* :ref:`Problems<Components and Activities TOC>`
@@ -48,7 +52,7 @@ In addition to the courseware described above, you course can contain
4852
supplemental content, such as textbooks, custom pages, and files. The
4953
following list describes the types of supported content.
5054

51-
* Course about pages appear in the course list for prospective students and are
55+
* Course about pages appear in the default Open edX course catalog for prospective students and are
5256
used to market your course. For more information, see :ref:`Course Overview`.
5357

5458
* Course assets are any supplemental files you use in your course, such as a
@@ -87,5 +91,5 @@ control grading and content experiments. For more information, see
8791
+--------------+-------------------------------+----------------+--------------------------------+
8892
| Review Date | Working Group Reviewer | Release |Test situation |
8993
+--------------+-------------------------------+----------------+--------------------------------+
90-
| | | | |
94+
| 2025-11-06 | sarina | Ulmo | Pass |
9195
+--------------+-------------------------------+----------------+--------------------------------+

0 commit comments

Comments
 (0)