Merge pull request #190 from edx/ahodges/doc/DOC1039

Enrollment activity by track

docs/en_us/dashboard/source/Reference.rst

@@ -85,14 +85,45 @@ For information about viewing enrollment activity data in edX Insights, see
 
 **Enrollment Over Time chart**
 
-* The markers on the chart represent the number of users enrolled in the
-  course each day.
+* The filled area of this stacked area chart represents the total
+  number of users enrolled in the course each day.
 
-* The x-axis shows dates from course creation through the end of
-  the last update period.
+* The x-axis shows dates from course creation through the end of the last
+  update period.
+
+* The y-axis shows the total number of enrolled users. 
+
+* For courses that offer more than one enrollment option or certification
+  track, different colors in the filled area represent the contribution of each
+  option and track to the enrollment total.
+
+  In addition to honor code certificates, courses can offer a verified
+  certificate option or enroll students through a professional education
+  program.
+
+* Each enrolled student is included in one, and only one, of the possible
+  enrollment tracks on a given date. The student's enrollment track as of 23:59
+  UTC is used each day.
 
-* The y-axis shows the number of enrolled users.
+**Enrollment Over Time report**
+
+* If a course offers students the option to pursue a verified certificate, the
+  report includes columns for **Verified Enrollment** and **Honor Code
+  Enrollment**.
 
+* If a course enrolls students through a professional education program, the
+  report includes columns for **Professional Enrollment** and **Honor Code
+  Enrollment**.
+
+* The **Honor Code Enrollment** column reports the count of students who opted
+  to receive an honor code certificate for the course.
+
+  At one time, the edx.org site offered students options to "audit" the course
+  only, or to audit the course and then receive an "honor" certificate when a
+  passing grade was achieved. For courses that ran at that time, the **Honor
+  Code Enrollment** column reports the sum of the students with these
+  enrollment options.
+
 .. _Demographic Computations:
 
 *********************************
@@ -366,4 +397,4 @@ In the following situations, data may not be available in edX Insights.
 * For courses that do not have any recorded student interactions, such as test
   courses and courses that finished running early in the history of the edX
   platform, data for enrollment activity and student engagement may not be
-  available.
+  available.

docs/en_us/dashboard/source/change_log.rst

@@ -8,7 +8,9 @@ Change Log
 
    * - Date
      - Change
-   * - 11/25/14
+   * - 12/9/14
+     - Updated :ref:`Enrollment_Activity` to include enrollment tracks.
+   * -
      - Expanded the section on possible :ref:`error conditions<Error
        Conditions>`.
    * - 11/24/14

docs/en_us/dashboard/source/enrollment/Enrollment_Activity.rst

@@ -23,23 +23,34 @@ information about the computations, see :ref:`Reference`.
 Daily Student Enrollment Chart
 ======================================
 
-Each marker on this chart represents the total number of enrolled learners on a
-particular date. Moving your cursor over the chart shows a tool tip with the
-enrollment count for each day.
+The daily student enrollment chart is a stacked area chart: the filled area
+represents the total number of enrolled learners on a particular date. For
+courses that offer more than one enrollment option or track, different colors
+represent the number of students who are enrolled with each option. 
 
-The chart includes enrollment data for every day, beginning with the automated
-enrollment of the course creator when the course was created in Studio. This
-data is also available for review in tabular format and can be downloaded.
+The chart currently includes these enrollment options and tracks, if they are
+offered for your course.
+
+* Honor certificate 
+* Verified certificate
+* Professional education program
+
+Moving your cursor over the chart shows a tool tip with the counts for each
+enrollment type, and the total enrollment, for each day.
+
+The chart includes enrollment data for every day, beginning with the first
+enrollment (typically of the course creator). This data is also available for
+review in tabular format and can be downloaded.
 
 A couple of examples of this chart follow for different courses. In the first
-example, you see the enrollment climb fairly steadily over a period of five months for a MOOC. The markers begin with 2 "student" enrollments (almost
+example, for a MOOC, you see enrollment climb fairly steadily over a period of 
+several months. The markers begin with two "student" enrollments (almost
 certainly the course creator and another staff member) on the day the course
-was created in Studio. 
+was created in Studio.
 
 .. image:: ../images/enrollment_chart.png
- :alt: The Daily Student Enrollment chart for nearly six months. The periods
-       when the rate of enrollment was greater are circled, and the tip for the
-       course start date on October 24th is shown.
+ :alt: The Daily Student Enrollment chart for six months. The periods when the
+       rate of enrollment was greater are circled.
 
 .. ColumbiaX/HIST1.1x/3T2014/enrollment/activity/
 
@@ -52,11 +63,12 @@ increase.
 
 The second example shows the Daily Student Enrollment chart for a small,
 private online course. In this course, the course team used the Instructor
-Dashboard to autoenroll all of the students.
+Dashboard to automatically enroll all of the students.
 
 .. image:: ../images/enrollment_chart_SPOC.png
- :alt: The Daily Student Enrollment chart with a nearly vertical line showing
-       an increase from just over 0 to over 700 students in a two week period.
+ :alt: A Daily Student Enrollment chart with a nearly vertical line showing
+       an increase from just over 0 to over 700 students in a two week period. 
+       The mouseover tip for May 17, 2014 is shown.
 
 .. IMFx/OL14.01/2T2014/enrollment/activity/
 
@@ -77,6 +89,21 @@ Change in Last Week Metric
 This metric reports the difference between the enrollment total at the
 end of the day yesterday and at the end of the day one week ago.
 
+======================================
+Verified Enrollment Metric
+======================================
+
+This count reports the total number of enrolled students who have elected to
+pursue a verified certificate for the course. 
+
+======================================================
+Change in Verified Enrollments Last Week Metric
+======================================================
+
+This metric reports the difference between the number of enrolled students who
+are in the verified certificate track as of the end of the day yesterday and at
+the end of the day one week ago.
+
 ======================================
 Enrollment Over Time Report 
 ======================================
@@ -85,13 +112,23 @@ The daily total enrollment count, through the date of the last update, is
 available for review or download. Columns show each **Date** and its **Total
 Enrollment**.
 
+The report includes additional columns for courses that offer certification
+options or enrollment tracks in addition to the honor certificate audit track.
+For courses with multiple enrollment tracks, the report includes the **Verified
+Enrollment** or **Professional Enrollment** column, or both. The report also
+includes the **Honor Code Enrollment** column for the count of enrolled
+students who did not elect one of those options.
+
 To download the Enrollment Over Time report in a comma-separated value file,
 click **Download CSV**. The CSV file contains the following columns: 
 
-* count
+* count (total enrollment)
 * course_id
 * created (the date and time of the computation)
 * date
+* honor
+* professional
+* verified
 
 .. info on why you might want to download, what to do with csv after
 

docs/en_us/dashboard/source/front_matter/browsers.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/browsers.rst

docs/en_us/dashboard/source/front_matter/index.rst

@@ -0,0 +1,11 @@
+#############################
+For Your Information
+#############################
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   read_me
+   preface
+   browsers

docs/en_us/dashboard/source/front_matter/preface.rst

@@ -0,0 +1 @@
+.. include:: ../../../shared/preface.rst

docs/en_us/dashboard/source/index.rst

@@ -10,10 +10,8 @@ Using edX Insights
    :numbered:
    :maxdepth: 2
 
-   read_me
-   preface
-   browsers
    change_log
+   front_matter/index
    Overview
    enrollment/index
    engagement/index

docs/en_us/shared/preface.rst

@@ -150,7 +150,7 @@ Documentation
 
 Documentation for developers is available on the docs.edx.org web page.
 
-* `edX Platform Developer's Guide`_ collects information directly from edX
+* The `edX Platform Developer's Guide`_ collects information directly from edX
   platform python docstrings. The topics in this guide include guidelines for
   contributing to Open edX, options for extending the Open edX platform, using
   the edX public sandboxes, instrumenting analytics, and testing.