From 7c09ebb794c78599f9c761c3213d0d712b978764 Mon Sep 17 00:00:00 2001 From: Andy Armstrong Date: Tue, 18 Jul 2017 16:02:13 -0400 Subject: [PATCH] Improve documentation for the Open edX features --- lms/djangoapps/learner_dashboard/README.rst | 38 ++++++++----- openedx/features/course_bookmarks/README.rst | 9 +++ openedx/features/course_experience/README.rst | 56 +++++++++++++++++++ openedx/features/course_search/README.rst | 7 +++ openedx/features/coursetalk/README.rst | 7 +++ openedx/features/learner_profile/README.rst | 8 +++ 6 files changed, 111 insertions(+), 14 deletions(-) create mode 100644 openedx/features/course_bookmarks/README.rst create mode 100644 openedx/features/course_experience/README.rst create mode 100644 openedx/features/course_search/README.rst create mode 100644 openedx/features/coursetalk/README.rst create mode 100644 openedx/features/learner_profile/README.rst diff --git a/lms/djangoapps/learner_dashboard/README.rst b/lms/djangoapps/learner_dashboard/README.rst index 3eb90c472a..28284508b1 100644 --- a/lms/djangoapps/learner_dashboard/README.rst +++ b/lms/djangoapps/learner_dashboard/README.rst @@ -1,28 +1,38 @@ Learner Dashboard ================= -This Django app hosts dashboard pages used by edX learners. The intent is for this Django app to include the following three important dashboard tabs: +This Django app hosts dashboard pages used by edX learners. The intent is for +this Django app to include the following dashboard tabs: + - Courses - Programs - - Profile Courses ---------------- -The learner-facing dashboard listing active and archived enrollments. The current implementation of the dashboard resides in ``common/djangoapps/student/``. The goal is to replace the existing dashboard with a Backbone app served by this Django app. +------- + +The learner-facing dashboard listing active and archived enrollments. The +current implementation of the dashboard resides in +``common/djangoapps/student/``. The goal is to replace the existing dashboard +with a Backbone app served by this Django app. Programs ---------------- -A page listing programs in which the learner is engaged. The page also shows learners' progress towards completing the programs. Programs are structured collections of course runs which culminate into a certificate. +-------- + +A page listing programs in which the learner is engaged. The page also shows +learners' progress towards completing the programs. Programs are structured +collections of course runs which culminate into a certificate. Implementation -^^^^^^^^^^^^^^^^^^^^^ -The ``views`` module contains the Django views used to serve the Program listing page. The corresponding Backbone app is in the ``edx-platform/static/js/learner_dashboard``. +^^^^^^^^^^^^^^ + +The ``views`` module contains the Django views used to serve the Program listing +page. The corresponding Backbone app is in the +``edx-platform/static/js/learner_dashboard``. Configuration -^^^^^^^^^^^^^^^^^^^^^ -In order to turn on the Programs tab, you need to update the ``Programs API Config`` object in the lms Django admin. Make sure you set the values ``Enabled``, ``Do we want to show program listing page`` and ``Do we want to show xseries program advertising`` to be true - -Profile ---------------- -A page allowing learners to see what they have accomplished and view credits or certificates they have earned on the edX platform. +^^^^^^^^^^^^^ +In order to turn on the Programs tab, you need to update the ``Programs API +Config`` object in the lms Django admin. Make sure you set the values +``Enabled``, ``Do we want to show program listing page`` and ``Do we want to +show xseries program advertising`` to be true diff --git a/openedx/features/course_bookmarks/README.rst b/openedx/features/course_bookmarks/README.rst new file mode 100644 index 0000000000..285e109341 --- /dev/null +++ b/openedx/features/course_bookmarks/README.rst @@ -0,0 +1,9 @@ +Course Bookmarks +---------------- + +This directory contains a Django application that provides a page +for a user to see all of their course bookmarks. It also registers +a course tool called "Bookmarks" that provides a link to this page. +For more information about the feature, see `Bookmarking Course Content`_. + +.. _Bookmarking Course Content: https://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/SFD_bookmarks.html diff --git a/openedx/features/course_experience/README.rst b/openedx/features/course_experience/README.rst new file mode 100644 index 0000000000..8c94ecaa00 --- /dev/null +++ b/openedx/features/course_experience/README.rst @@ -0,0 +1,56 @@ +Course Experience +----------------- + +This directory contains a Django application that provides the Course Home page +(or course landing page), and various resources in support of the landing +experience. + +The course experience consists of a number of views: + +1. **Course Home** + + The course home page is the landing page for the course. It presents + the learner with information necessary to understand the purpose of the + course, its content, and its milestones. It includes a "Course Tools" + section that provides links to other tools associated with the course. + For example, it includes tools such as reviews, updates and bookmarks. + +2. **Welcome Message** + + The welcome message is a fragment view which is typically shown on the + course home page. It provides the user with a description of the course + and helps them to understand its requirements. + +3. **Course Outline** + + The course outline is a fragment view which shows an outline of the content + of the course. + +4. **Course Dates** + + The course dates fragment is a view which shows users important dates for the + course, such as the start and end dates. + +5. **Course Sock** + + The course sock is a fragment view which is typically shown just above + the footer of course pages (hence the name). The default implementation + presents the users with a message encouraging them to purchase a verified + certificate. + +6. **Course Updates** + + The course updates page shows the user all of the course team's updates + in a scrolling list. The updates page is also provided as a course tool. + +7. **Course Reviews** + + This page shows the user reviews of the course from an external provider. + The default provider is `CourseTalk`_. The reviews page is also provided + as a course tool. + +A number of the features in the course experience are controlled via Waffle +flags. For documentation, see `Waffle flag definitions`_. + +.. _CourseTalk: https://www.coursetalk.com/ +.. _Waffle flag definitions: https://github.com/edx/edx-platform/blob/master/openedx/features/course_experience/__init__.py diff --git a/openedx/features/course_search/README.rst b/openedx/features/course_search/README.rst new file mode 100644 index 0000000000..c6925c2967 --- /dev/null +++ b/openedx/features/course_search/README.rst @@ -0,0 +1,7 @@ +Course Search +------------- + +This directory contains a Django application that allows a learner to search +the content of their course. To learn more, see `Enabling Open edX Search`_. + +.. _Enabling Open edX Search: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/edx_search.html diff --git a/openedx/features/coursetalk/README.rst b/openedx/features/coursetalk/README.rst new file mode 100644 index 0000000000..c117324b3b --- /dev/null +++ b/openedx/features/coursetalk/README.rst @@ -0,0 +1,7 @@ +CourseTalk +---------- + +This directory contains a Django application that integrates `CourseTalk`_ +as a course review provider for Open edX. + +.. _CourseTalk: https://www.coursetalk.com/ diff --git a/openedx/features/learner_profile/README.rst b/openedx/features/learner_profile/README.rst new file mode 100644 index 0000000000..0dce8e10cc --- /dev/null +++ b/openedx/features/learner_profile/README.rst @@ -0,0 +1,8 @@ +Learner Profile +--------------- + +This directory contains a Django application that provides a view to render +a profile for any Open edX learner. See `Exploring Your Dashboard and Profile`_ +for more details. + +.. _Exploring Your Dashboard and Profile: https://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/SFD_dashboard_profile_SectionHead.html?highlight=profile