Merge pull request #396 from edx/markhoeber-doc1877

Doc for CCX

en_us/course_authors/source/building_course/index.rst

@@ -22,5 +22,4 @@ see :ref:`Developing Your Course Index`.
    textbooks
    establish_grading_policy
    course_rerun
-   custom_courses
    export_import_course

en_us/install_operations/source/configuration/enable_ccx.rst

@@ -0,0 +1,31 @@
+.. include:: ../links.rst
+
+.. _Enable CCX:
+
+####################################
+Enabling Custom Courses
+####################################
+
+To enable designated users to create custom courses (CCX) on your instance of
+Open edX, you must configure the ``server-vars.yml`` file in the edX platform.
+
+.. Note::  
+  Before proceeding, review :ref:`Guidelines for Updating the edX Platform`.
+
+#. Stop the LMS server.
+
+#. Create or update the file ``/edx/app/edx_ansible/server-vars.yml`` to
+   include the CCX feature flag.
+
+  .. code-block:: yaml
+
+    EDXAPP_FEATURES:
+      CUSTOM_COURSES_EDX: true
+
+3. Run the command ``/edx/bin/update``.
+
+  .. code-block:: bash
+
+     sudo /edx/bin/update edx-platform <your-branch-name>
+
+4. Restart the LMS server.

en_us/install_operations/source/configuration/index.rst

@@ -18,4 +18,5 @@ options.
    edx_search
    enable_certificates
    enable_badging
+   enable_ccx
 

en_us/install_operations/source/front_matter/change_log.rst

@@ -8,6 +8,8 @@ Change Log
 
    * - Date
      - Change
+   * - 16 June 2015
+     - Added the :ref:`Enable CCX` section.
    * - 8 June 2015
      - Added :ref:`Enable edX Search`.
    * - 

en_us/open_edx_course_authors/source/building_course/index.rst

@@ -25,4 +25,5 @@ see :ref:`Developing Your Course Index`.
    establish_grading_policy
    creating_course_certificates
    course_rerun
+   custom_courses
    export_import_course

en_us/open_edx_course_authors/source/front_matter/change_log.rst

@@ -12,6 +12,8 @@ Apr-Jun 2015
 
    * - Date
      - Change
+   * - 16 Jun 2015
+     - Added the :ref:`Creating a Custom Course` section.
    * - 10 Jun 2015
      - Added the :ref:`view_not_yet_enrolled` section.
    * - 8 Jun 2015

en_us/shared/building_and_running_chapters/building_course/custom_courses.rst

@@ -4,175 +4,166 @@
 Creating a Custom Course
 ########################
 
-Custom Courses for edX (CCX) is an edX feature for re-using course
-content. CCXs allow course staff to run some or all of
-an existing course for a group of students on a new schedule. 
-CCXs may only contain content from an existing course; they do 
-not function as a course authoring tool. All CCX features are 
-configurable in edX Learning Management System by a CCX Coach, 
-a role created by a course Instructor. 
-
-There are three roles associated with a CCX. 
-
--   Instructors created the existing course and have privileges to 
-    create CCX Coaches.
--   CCX Coaches select content from the existing course for the CCX.
-    Coaches also enroll students, set start and due dates for their
-    scheduled content, and manage grading policy for the CCX.
--   Students take the CCX viewing the selected content on the 
-    specified schedule.
+This topic describes custom courses on the edX platform (CCX).
+
+.. contents:: Section Contents
+  :local:
+  :depth: 1
+
+**************************
+Overview
+**************************
+
+You can create a custom course in the edX platform (CCX) to reuse course
+content. By using a CCX, you can run some or all of an existing course for a
+group of students on a new schedule.
+
+A CCX can contain only content from an existing course; you cannot author new
+content in a CCX. 
 
 **************************
- Enabling CCX for a Course
+Custom Courses and Roles
 **************************
 
-CCX for a course is disabled by default. It is enabled in Studio.
+There are three roles involved in creating and running a CCX. 
+
+* **Instructors** create the existing course and have privileges to create CCX
+  coaches for their course.
+
+* **CCX Coaches** select content from the existing course for the CCX. CCX
+  coaches also enroll learners, set start and due dates for their scheduled
+  content, and manage the grading policy for the CCX.
+
+* **Learners** take the CCX and view the selected content on the specified
+  schedule.
+
+************************************************
+Enable Custom Courses for an Existing Course
+************************************************
+
+CCX for a course is disabled by default.
+
+You enable CCX in Studio. Ensure you have access to the course in Studio, then
+complete the following steps.
+
+#. In Studio, from the **Settings** menu, select **Advanced Settings**.
+
+#. Find the ``Enable CCX`` key and change the value to ``true``.
 
-1. Ensure you have Studio access to the course.
-#. Open the course in Studio and navigate to ``Advanced Settings``
-   from the ``Settings`` menu.
-#. Find the ``Enable CCX`` setting and change it to ``true``.
 #. Click ``Save Changes``.
 
-You can now add a CCX Coach.
+You can now add a CCX coach.
 
 *******************
- Adding a CCX Coach
+Add a CCX Coach
 *******************
 
-The first step to create a CCX is for an instructor to 
-create a CCX Coach in an existing course. At this time, a CCX can 
-have only one coach.
+The first step to create a CCX is to create a CCX coach in an existing course.
+A CCX can have only one CCX coach.
+
+You add a CCX coach through the Instructor Dashboard in the LMS. Ensure you
+have Instructor access to the course.
 
-1. Ensure you have Instructor access.
-#. Ensure that the new CCX Coach has registered with the LMS.
-#. From the **instructor** tab select **Membership**. 
-#. If the CCX Coach is not already enrolled in the course, enroll
-   them now.
-#. In the **Administration List Management** section, select **CCX Coaches** 
-   from **Select an Administrator Group**.
-#. Enter the coach's username or email and select **Add CCX Coach**.
+In addition, ensure that the new CCX coach has registered in the LMS and
+enrolled in the course.
 
-When the CCX Coach next logs into the LMS, the **CCX Coach** tab will 
-be visible. The CCX Coach dashboard is not accessible by the instructor.
+#. In the LMS, from the **Instructor** tab select **Membership**. 
+
+#. In the **Administration List Management** section, from **Select an
+   Administrator Group**, select **CCX Coaches**.
+
+#. Enter the CCX coach's username or email address and select **Add CCX
+   Coach**.
+
+When the CCX coach next logs into the LMS, the **CCX Coach** tab will 
+be visible. The CCX coach dashboard is not accessible by the instructor.
 
 ***************************
- Creating the Custom Course
+ Create the Custom Course
 ***************************
 
-1. Ensure that you are a CCX Coach.
-#. Select the **CCX Coach** tab. 
-#. From the CCX Coach Dashboard, enter the name for your CCX
-   and select **Coach a new Custom Course for edX**.
-#. Once your CCX is created, you will be re-directed to the 
-   full CCX Coach Dashboard.
+When you have been made the CCX coach for a course, you can then access the
+course and create a CCX.
+
+#. In the LMS, select the **CCX Coach** tab. 
+
+#. From the CCX coach Dashboard, enter the name for your CCX, then select
+   **Coach a new Custom Course for edX**.
+
+#. When the CCX is created, you are re-directed to the full CCX coach
+   Dashboard.
 
 .. note:: 
-    When choosing a CCX name, consider that the name should 
+    When entering a CCX name, consider that the name should 
     distinguish your CCX from other CCXs based on the same course.
 
-You can revisit your CCX by opening the original course and clicking 
+You can revisit your CCX by opening the original course and selecting 
 the ``CCX Coach`` tab.
 
 ************************
  The CCX Coach Dashboard
 ************************
 
-CCX Coaches don't have the same level of access and control over content 
-that course instructors have, and do not have access to 
-the instructor tab. The CCX Coach dashboard provides the interfaces to 
-manage their CCX. The CCX Coach dashboard contains four tabs, described 
-in the following sections.
+The CCX coach Dashboard provides the tools for you to manage the CCX. The CCX
+coach Dashboard contains four tabs, described in the following sections.
+
+.. note::
+  CCX coaches don't have the same level of access and control over content that
+  course instructors have, and do not have access to the Instructor Dashboard.
 
 ============
 Schedule Tab
 ============
 
-The Schedule tab allows the CCX Coach to select the course content 
-from the original course that the CCX will deliver. The drop-downs 
-allow the coach to drill down through the course elements to select 
-an item from anywhere in the content hierarchy and add those items 
-in the sequence of their choice. Select **add all units** to include 
-all of the source course's content. 
+On the **Schedule** tab, you select the course content from the original course
+that is to be included in the CCX.
+
+Use the drop-down lists to drill down through the course content and
+select an items from the content hierarchy. You then add those items in
+the order needed.
 
-Each item can optionally have its own start and due dates. These dates
-can be selected either before or after items are added to the CCX 
-content hierarchy. Once items are added their start and due dates 
-can be edited by hovering over or selecting that space on the CCX 
-content hierarchy. 
+Select **add all units** to include all of the source course's content.
 
-All changes are temporary until **Save changes** is selected.
+You can configure each unit to have its own start and due dates. You can select
+these before or after you add the unit to the CCX . After units are added, you
+can edit their start and due dates by hovering over or selecting that space on
+the CCX content hierarchy.
+
+Select **Save changes** to save the content you configured.
 
 ==============
 Enrollment Tab
 ==============
 
-The Enrollment tab contains controls to invite and manage the 
-students for the CCX. Use **Student List Management** to add 
-individual students who are already registered on the platform. 
-Students added in **Batch Enrollment** will receive an email 
-invitation if **Notify users by email** is selected. Students 
-are automatically enrolled in the CCX when they accept their 
-invitation.
+The **Enrollment** tab contains controls to invite and manage learners. Select
+**Student List Management** to add individual students who are already
+registered on the platform.
+
+To have students added in through Batch Enrollment receive an email invitation
+to the CCX, select **Notify users by email**.  Students are automatically
+enrolled in the CCX when they access the invitation.
 
 =================
 Student Admin Tab
 =================
 
-The Student Admin tab contains links to view the gradebook and 
-download student grades.
+You use the **Student Admin** tab to view the gradebook and download student
+grades.
 
 ==================
 Grading Policy Tab
 ==================
 
-The Grading Policy tab allows CCX Coaches to modify the grading 
-policy. A CCX coach can modify the grading policy of the underlying 
+Use the **Grading Policy** tab to modify the grading policy for the CCX.
+
+A CCX coach can modify the grading policy of the underlying 
 course for their CCX. 
 
 .. note:: 
-    Only attempt this if you are confident that you understand 
-    how your changes will affect grading. Modifying the grading
+    As a CCX coach, you can modify the grading policy of the original course on
+    which the CCX was based. Only attempt this if you are confident that you
+    understand how your changes will affect grading. Modifying the grading
     policy can make your CCX unusable.
 
 The grading policy is in JSON format. Verify that it is well-formed 
 before selecting **Save Grading Policy**.
-
-*********************
-System Administrators
-*********************
-
-=====================
-What does CCX change?
-=====================
-
-CCX makes a number of changes to the edX platform. It is 
-outside the scope of this document to describe them in detail, 
-but here are a few of the most important.
-
-- CCX exists only in LMS. There is no Studio configuration. 
-- CCX makes no changes to the course XML(OLX).
-- Once enabled, CCX is available for all courses. 
-
-=======================
-System Installation
-=======================
-
-Enable CCX by making this change to the edx-platform. 
-
-1. Create or update ``/edx/app/edx_ansible/server-vars.yml`` to include
-   the CCX feature flag.
-
-.. code-block:: yaml
-
-   EDXAPP_FEATURES:
-     CUSTOM_COURSES_EDX: true
-
-2. Run ``/edx/bin/update``
-
-.. code-block:: bash
-
-   sudo /edx/bin/update edx-platform <your-branch-name>
-
-You can now start lms and use CCX. 
-