Merge pull request #2976 from edx/ahodges/documentation/hackathon

Instructor dash changes for DOC-231, resequencing for DOC-230

docs/en_us/course_authors/source/change_log.rst

@@ -10,6 +10,8 @@ Change Log
 
    * - Date
      - Change
+   * - 3/19/14
+     - Updated the sections on :ref:`Beta_Testing`, :ref:`Discussions`, :ref:`Grades`, and :ref:`Student Data` with changes to the new Instructor Dashboard.
    * - 03/17/14
      - Reorganized this document into major sections: 
 

docs/en_us/course_authors/source/releasing_course/beta_testing.rst

@@ -172,9 +172,9 @@ Add the Beta Testers
 
 Before you can add beta testers:
 
-* You need the email address of each beta tester. 
+* You need the email address or username of each beta tester. 
 
-* Each beta tester must register a user account for that email address, activate the account, and be enrolled in your course. 
+* Each beta tester must register a user account for that email address and username, activate the account, and be enrolled in your course. 
 
 **Note**: If the beta test starts before the **Enrollment Start Date**, testers cannot enroll themselves. To streamline this process, ask the beta testers to register and activate their accounts. Then, you can enroll the beta testers and select the **Auto Enroll** and **Notify students by email** options. See :ref:`Enrollment`.
 
@@ -188,13 +188,13 @@ To add a beta tester:
 
 #. In the Administration List Management section, use the drop-down list to select **Beta Testers**.
 
-#. Under the list of users who currently have that role, enter an email address and click **Add Beta Tester**.
+#. Under the list of users who currently have that role, enter an email address or username and click **Add Beta Tester**.
 
   * If you add beta testers after the defined start of the beta test, they see your course on their dashboards when they log in. 
 
   * If you add beta testers before the test starts, they do not see your course. You may need to remind them when the test begins. 
 
-To remove the Beta Testers role, view the list of beta testers and then click revoke access (the **X**) next to that email address. 
+To remove the Beta Testers role, view the list of beta testers and then click **Revoke access**. 
 
 .. _Issue_Reporting_During_Course:
 

docs/en_us/course_authors/source/running_course/course_grades.rst

@@ -91,7 +91,7 @@ To download a file of student grades:
 
 #. To open or save a grade report file, click the *course_id* \_grade_report_\ *date*.csv file name at the bottom of the page.
 
-.. note:: To prevent the accidental distribution of student data, you can only download these files by clicking the links on this page. You cannot copy a link and save it or email it, as the value for the link that you copy expires within five minutes.
+**Note**: To prevent the accidental distribution of student data, you can only download these files by clicking the links on this page. You cannot copy a link and save it or email it, as the value for the link that you copy expires within five minutes.
 
 =========================================================
 Check the progress of a single student
@@ -144,7 +144,7 @@ View a histogram of scores for a problem
 
 You can view a chart of the score distribution for a specified problem.
 
-.. note:: In order to view the score distribution for a problem, you need its unique identifier. See :ref:`find_URL`.
+**Note**: In order to view the score distribution for a problem, you need its unique identifier. See :ref:`find_URL`.
 
 To display demographic distributions for gender and educational attainment:
 
@@ -159,7 +159,7 @@ To display demographic distributions for gender and educational attainment:
    A graph displays a histogram of scores for that problem.
 
 ..  **Question**: (sent to Olga 31 Jan 14) this is a tough UI to use: how do they correlate the codes in this drop-down with actual constructed problems? the copy-and-paste UI on the Student Admin page actually works a little better imo.
-.. **Question**: I'd like to include an image, but need a good example. Elina suggested using the edX demo course (I don't have access), and a problem that has multiple possible answers
+.. **Question**: I'd like to include an image, but need a good example. Elina suggested using the edX demo course (I don't have access), and a problem that has multiple possible answers 
 
 .. _Adjust_grades:
 
@@ -201,7 +201,7 @@ To find the unique identifier in the URL for a problem:
 
 #. To copy the identifier that is assigned to the problem, select it, right click, and choose **Copy**.
 
-   .. note:: If the URL does not include "problem/" before the identifer, you will need to specify that module identifier as well. Select and copy both the module identifer and the problem identifier.
+   **Note**: If the URL does not include "problem/" before the identifer, you will need to specify that module identifier as well. Select and copy both the module identifer and the problem identifier.
 
    To close the Staff Debug viewer, click on the browser page outside of the viewer.
 
@@ -211,7 +211,7 @@ Rescore student submissions
 
 Each problem that you define for your course includes a correct answer, and may also include a tolerance or acceptable alternatives. If you decide to make a change to these values, you can rescore any responses that were already submitted. For a specified problem, you can rescore the work submitted by a single student, or rescore the submissions made by every enrolled student. 
 
-.. note:: You can only rescore problems that have a correct answer entered in edX Studio. Problems that are scored by an external grader cannot be rescored with this procedure.
+**Note**: You can only rescore problems that have a correct answer entered in edX Studio. Problems that are scored by an external grader cannot be rescored with this procedure.
 
 To rescore a problem, you need its unique identifier. See :ref:`find_URL`.
 
@@ -245,7 +245,7 @@ When you create a problem, you can limit the number of times that a student can
 
 For more information about modifying a released problem, including other workarounds, see :ref:`Modifying a Released Problem`.
 
-.. note:: To reset the number of attempts for a problem, you need its unique identifier. See :ref:`find_URL`.
+**Note**: To reset the number of attempts for a problem, you need its unique identifier. See :ref:`find_URL`.
 
 To reset student attempts for a problem:
 

docs/en_us/course_authors/source/running_course/course_staffing.rst

@@ -54,9 +54,9 @@ Assign staff roles
 
 Before you can assign the course staff or instructor role to a team member:
 
-* You need the email address of each team member. 
+* You need the email address or username of each team member. 
 
-* Each team member must register a user account for that email address and enroll in your course.
+* Each team member must register a user account for that email address/username and enroll in your course.
 
 To assign a staff role:
 
@@ -68,8 +68,7 @@ To assign a staff role:
 
 #. In the Administration List Management section, use the drop-down list to select **Course Staff** or **Instructors**.
 
-#. Under the list of users who currently have that role, enter an email address and click **Add** for the role type.
-
-To remove an assigned role, view the list of users and then click revoke access (the **X**) next to that email address. 
+#. Under the list of users who currently have that role, enter an email address or username and click **Add** for the role type.
 
+To remove an assigned role, view the list of users and then click **Revoke access**. 
 

docs/en_us/course_authors/source/running_course/course_student.rst

@@ -34,7 +34,7 @@ Course authors should follow the policies established by their organizations and
 Access student data
 ****************************
 
-You can view data about the students who are currently enrolled in your course. Data for enrolled students is also available for download in CSV (comma-separated values) format.  
+You can download data about the students who are currently enrolled in your course in a CSV (comma-separated values) file. For courses that have fewer than 200 students enrolled, you can also view data for enrolled students on the Instructor Dashboard.  
 
 ======================
 Student-reported data
@@ -60,17 +60,21 @@ You can access this self-reported information for all of the students who are en
 
 The student data that is available to course staff always reflects the set of live, current enrollments. Students can register for your course throughout the defined enrollment period, and they can unregister from a course at any time, which unenrolls them. Students can also change their email addresses and full names at any time. As a result, you may want to download student data periodically to gain insights into how the student population changes over time. 
 
+**Note**: In the future, edX may also request that students select a language and location. This data is not collected at this time.
+
 .. _View and download student data:
 
 ==========================================
-View and download student data
+Download or view student data
 ==========================================
 
-You can view and download student data to learn about population demographics at a specific point in time, compare demographics at different points in time, and plot trends in the population over time.
+You can download student data to learn about population demographics at a specific point in time, compare demographics at different points in time, and plot trends in the population over time. 
 
 **Important**: Do not navigate away from this page while you wait for the data to be prepared. The larger the enrollment for your course, the longer it takes to create and output the data. 
 
-To view or download student data:
+For smaller courses, you also have the option to view student data on the Instructor Dashboard. 
+
+To download or view student data:
 
 #. View the live version of your course.
 
@@ -78,20 +82,18 @@ To view or download student data:
 
 #. Click **Data Download**.
 
-#. To display student enrollment data, click **List enrolled students' profile information**.
+#. To download student enrollment data in a CSV file, click **Download profile information as a CSV**.
+
+   You are prompted to open or save the enrolled_profiles.csv file. All student-supplied data is included without truncation.
+
+#. To display student enrollment data, click **List enrolled students' profile information**. (This option is available only for courses with an enrollment of less than 200.)
 
    A table of the student data displays, with one row for each enrolled student. Longer values, such as student goals, are truncated.
 
  .. image:: ../Images/StudentData_Table.png
   :alt: Table with columns for the collected data points and rows for each student on the Instructor Dashboard
 
- .. note:: In the future, edX may also request that students select a language and location. This data is not collected at this time.
-
-5. To download student enrollment data in a CSV file, click **Download profile information as a CSV**.
-
-   You are prompted to open or save the enrolled_profiles.csv file. All student-supplied data is included without truncation.
-
-**Note**: In addition to the data for enrolled students, data for the course staff is included in the display or file.
+**Note**: In addition to the data for enrolled students, data for the course staff is included in the file or display.
 
 ==========================================
 View demographic distributions
@@ -112,10 +114,10 @@ To display demographic data for your students:
    * The Gender Distribution and Level of Education sections show tables with counts of responses made by enrolled students.
 
    .. image:: ../Images/Distribution_Education.png
-    :alt: Table with columns for different possible values for gender and total count reported for each value
+    :alt: Table with columns for different possible values for level of education completed and total count reported for each value
 
    .. image:: ../Images/Distribution_Gender.png
-    :alt: Table with columns for different possible values for level of education completed and total count reported for each value
+    :alt: Table with columns for different possible values for gender and total count reported for each value
 
    "No Data" is the sum of the students for whom no value exists for the demographic. 
 

docs/en_us/course_authors/source/running_course/discussions.rst

@@ -108,10 +108,10 @@ You can designate a team of people to help you run course discussions. Different
 
 **Note**: Discussion responses and comments made by course staff and instructors are also marked as "Staff".
 
-Before you can assign roles to your discussion administrators, you need their email addresses. 
+Before you can assign roles to your discussion administrators, you need their email addresses or usernames. 
 
-* To get the email address for a staff member, on the Instructor Dashboard click **Membership** and then select Course Staff from the drop-down list.
-* To get the email address of a student, on the Instructor Dashboard click **Data Download** > **List enrolled students' profile information**.
+* To get this information for a staff member, on the Instructor Dashboard click **Membership** and then select **Course Staff** from the drop-down list.
+* To get this information for an enrolled student, on the Instructor Dashboard click **Data Download** > **Download profile information as a CSV**.
 
 **Tip**: These instructions are for the new Instructor Dashboard: click **Try New Beta Dashboard**.
 
@@ -125,11 +125,9 @@ To assign a role:
 
 #. In the Administration List Management section, use the drop-down list to select Discussion Admins, Discussion Moderators, or Discussion Community TAs.
 
-#. Under the list of users who currently have that role, enter an email address and click **Add** for the role type.
+#. Under the list of users who currently have that role, enter an email address or username and click **Add** for the role type.
 
-#. To remove an assigned role, view the list of users and then click revoke access (the **X**) next to that email address. 
-
-You can also use the older version of the Instructor Dashboard. You need the usernames of your discussion moderators or students. Click **Forum Admin**, enter the username in the appropriate field, then click the **Add** button for the role you want to assign.  
+#. To remove an assigned role, view the list of users and then click **Revoke access**.
 
 .. _Running_discussions:
 
@@ -141,7 +139,7 @@ On an ongoing basis, discussion administrators run the course discussions by mak
 
 ========================
 Seed a discussion
-======================== 
+========================
 
 Before you contribute to a discussion, you can decide whether you want to be identified as a staff member or community TA, or to appear like other students' work. Depending on the subject and your purpose, one or the other might be more appropriate to spark discussion and inform students.
 
@@ -149,9 +147,9 @@ You can also post anonymously. Regardless of your role, you can choose to make a
 
 * To identify your posts with your role, log in with your discussion administrator email address and add the post or response. The responses and comments that you make include a colored banner with either "Staff" or "Community TA".
  
-* To post as a student, you must set up an alternate, test account with a different email address, go to the course URL and register, and then join the discussion. Reponses and comments do not have a banner and appear like any other student post. 
+* To post as a student, you must set up an alternate account with a different email address, go to the course URL and register, and then join the discussion. When you post as a student, your responses and comments do not have a banner or other distinguishing features: they appear the same as any other student post.
 
-note:: Posts by discussion administrators do not include a colored "Staff" or "Community TA" banner. Only responses to posts and comments made on responses do.
+**Note**: Posts by discussion administrators do not include a colored "Staff" or "Community TA" banner. The colored banner appears only when discussion administrators respond to existing posts or make a comment.
 
 ==========================================
 Use conventions in discussion subjects

docs/en_us/course_authors/source/running_course/index.rst

@@ -7,11 +7,11 @@ Running Your Course
 .. toctree::
    :maxdepth: 2
    
-   checking_student_progress
+   course_staffing
+   course_enrollment
    discussions
    discussion_guidance_moderators
    course_data
-   course_enrollment
-   course_staffing
    course_student
-   course_grades
\ No newline at end of file
+   course_grades
+   checking_student_progress
\ No newline at end of file