edx-platform

Files

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

api

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

static/course_experience

Remove Shorten Welcome Message flag

2020-05-08 15:25:59 -04:00

templates/course_experience

Deprecate COURSE_OUTLINE_PAGE_FLAG and UNIFIED_COURSE_TAB_FLAG

2020-10-27 10:20:41 +01:00

tests

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

views

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

__init__.py

Fixing code-annotations (#25539 )

2020-11-06 12:52:08 -05:00

.eslintrc.js

Fix extracting i18n from jsx code

2018-05-02 15:21:45 -04:00

course_tools.py

Extracting plugin app from edx-platform (#24678 )

2020-08-12 07:48:53 -04:00

plugins.py

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

README.rst

README for course_experience

2019-05-29 03:00:19 -04:00

urls.py

Remove unused URL.

2020-06-10 13:59:21 -04:00

utils.py

Use full names for common.djangoapps imports; warn when using old style (#25477 )

2020-11-10 07:02:01 -05:00

waffle.py

Fixing code-annotations (#25539 )

2020-11-06 12:52:08 -05:00

README.rst

Status: Maintenance

Responsibilities
================
The Course Experience directory contains a Django application that provides the
Course Home page (or course landing page), and various resources in support of
the landing experience.


Direction: Deprecate
====================
This will be replaced eventually by new UI in the form of Microfrontends.  New functionality should not be added here.


Glossary
========

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

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