chore: cleanup

- rst heading definitions
- indirect hyperlinks and code-blocks for better readability
This commit is contained in:
Emad Rad
2024-05-25 18:08:25 +03:30
parent c27d55a253
commit 4529041643
7 changed files with 94 additions and 61 deletions

View File

@@ -1,8 +1,8 @@
.. _Split Mongo Modulestore:
############################
#######################
Split Mongo Modulestore
############################
#######################
See:
@@ -11,9 +11,9 @@ See:
* `Split Mongo Capabilities`_
************************
********
Overview
************************
********
*Split Mongo* is the term used for the new edX modulestore. Split Mongo is
built on mongoDB. For information about mongoDB, see the `mongoDB website`_.
@@ -30,9 +30,9 @@ use more advanced capabilities when developing and managing courses.
.. _mongoDB website: http://www.mongodb.org
************************
**********************
Split Mongo Data Model
************************
**********************
In the Split Mongo data model, edX courses are split into three collections:
@@ -42,9 +42,9 @@ In the Split Mongo data model, edX courses are split into three collections:
.. Structures link is a workaround; "Course Structures" as label is already taken
=============
============
Course Index
=============
============
The course index is a dictionary that stores course IDs. Each course ID points
to a course structure.
@@ -69,13 +69,13 @@ In the edX Platform:
about page, course updates, other course pages, sections or subsections,
the draft branch is automatically published; that is, it becomes the
published branch.
* For units and components, changes are saved in the draft branch. The user
must publish the unit to change the draft branch to the published branch.
When the user begins another set of changes, the draft branch is updated.
Course Reruns
**************
*************
The edX Platform enables you to rerun a course. When you rerun a course, a new
course index is created. The new course index points to the same course
@@ -83,9 +83,9 @@ structure as the original course index.
.. _Structures:
==========================
=================
Course Structures
==========================
=================
The course structure defines, or outlines, the content of a course.
@@ -104,9 +104,9 @@ when a course author changes a course, or a block in the course, a new course
structure is saved; the previous course structure, and previous versions of
blocks within the structure, remain in the database and are not modified.
==========================
==================
XBlock Definitions
==========================
==================
XBlock definitions contain the content of each block. For some blocks, such as
sections and subsections, the definition consists of the block's display name.
@@ -129,7 +129,7 @@ enable:
* `Multiple Course Branches`_
* `Versioning`_
* `Content Reuse`_
While these capabilities are not fully implemented in the edX Platform, Split
Mongo is designed to allow future enhancements that enable these content
management capabilities.
@@ -145,9 +145,9 @@ different structure.
The edX Platform currently uses a draft and a published branch for a course.
Future enhancements may use other branches.
============
==========
Versioning
============
==========
In Split Mongo, every change to a course or a block within the course is saved,
with the time and user recorded.
@@ -155,9 +155,9 @@ with the time and user recorded.
Versioning enables future enhancements such as allowing course authors to
revert a course or block to a previous version.
==============
=============
Content Reuse
==============
=============
By using pointers to reference XBlock definitions from :ref:`course structures
<Structures>`, Split Mongo enables content reuse. A single `XBlock