Files
edx-platform/lms/djangoapps/learner_dashboard
Kyle McCormick 151bd13666 Use full names for common.djangoapps imports; warn when using old style (#25477)
* Generate common/djangoapps import shims for LMS
* Generate common/djangoapps import shims for Studio
* Stop appending project root to sys.path
* Stop appending common/djangoapps to sys.path
* Import from common.djangoapps.course_action_state instead of course_action_state
* Import from common.djangoapps.course_modes instead of course_modes
* Import from common.djangoapps.database_fixups instead of database_fixups
* Import from common.djangoapps.edxmako instead of edxmako
* Import from common.djangoapps.entitlements instead of entitlements
* Import from common.djangoapps.pipline_mako instead of pipeline_mako
* Import from common.djangoapps.static_replace instead of static_replace
* Import from common.djangoapps.student instead of student
* Import from common.djangoapps.terrain instead of terrain
* Import from common.djangoapps.third_party_auth instead of third_party_auth
* Import from common.djangoapps.track instead of track
* Import from common.djangoapps.util instead of util
* Import from common.djangoapps.xblock_django instead of xblock_django
* Add empty common/djangoapps/__init__.py to fix pytest collection
* Fix pylint formatting violations
* Exclude import_shims/ directory tree from linting
2020-11-10 07:02:01 -05:00
..
2019-05-01 08:00:17 -04:00
2019-12-30 10:35:30 -05:00
2019-12-30 10:35:30 -05:00

Status: Maintenance

Responsibilities
================

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

Direction: Deprecate
====================
This is being replaced by new UI that is in active development.  New functionality should not be added here.

Glossary
========

Courses
-------

The learner-facing dashboard listing active and archived enrollments. The
current implementation of the dashboard resides in
``common/djangoapps/student/``.

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.


More Documentation
==================

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``.

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