From 01a3c4e3cede292b93f6516d41d72d1aab276cfb Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Wed, 24 Sep 2014 11:06:18 -0400 Subject: [PATCH] Updates to browser and preface files --- .../course_authors/source/change_log.rst | 3 ++ .../source/running_course/course_data.rst | 8 ++++ .../running_course/course_enrollment.rst | 10 ++++- .../internal_data_formats/change_log.rst | 39 ++++++++++++++++++- .../source/internal_data_formats/package.rst | 14 ++++++- docs/en_us/shared/browsers.rst | 33 ++++++++++++++++ docs/en_us/shared/preface.rst | 24 ++++++++---- 7 files changed, 120 insertions(+), 11 deletions(-) diff --git a/docs/en_us/course_authors/source/change_log.rst b/docs/en_us/course_authors/source/change_log.rst index f964dfd510..c185dbf739 100644 --- a/docs/en_us/course_authors/source/change_log.rst +++ b/docs/en_us/course_authors/source/change_log.rst @@ -12,6 +12,9 @@ September, 2014 * - Date - Change + * - 09/30/14 + - Added information about accessing edX Insights to the :ref:`Course Data` + and :ref`Enrollment` chapters. * - 09/04/14 - Updated the :ref:`Discussions` and :ref:`Discussions for Students and Staff` chapters to include information about choosing the type of post diff --git a/docs/en_us/course_authors/source/running_course/course_data.rst b/docs/en_us/course_authors/source/running_course/course_data.rst index fd11c8bac9..10e31a3af5 100644 --- a/docs/en_us/course_authors/source/running_course/course_data.rst +++ b/docs/en_us/course_authors/source/running_course/course_data.rst @@ -13,6 +13,11 @@ Instructor Dashboard. You can find: * The defined grade cutoff for passing or failing. +Additional data about the course and its students is available from other pages +in the Instructor Dashboard, and from edX Insights. You also access Insights +from the Instructor Dashboard: click the link in the banner at the top of each +page. For more information, see `Using edX Insights`_. + ************************************************* Review Course Data ************************************************* @@ -75,3 +80,6 @@ Studio, or derived from data that you define in Studio. Grading can be changed in Studio (not recommended if your course is live): select **Settings** > **Grading**. + + +.. _Using edX Insights: http://edx-insights.readthedocs.org/en/latest/ \ No newline at end of file diff --git a/docs/en_us/course_authors/source/running_course/course_enrollment.rst b/docs/en_us/course_authors/source/running_course/course_enrollment.rst index fcec9f7d92..97a5637dc9 100644 --- a/docs/en_us/course_authors/source/running_course/course_enrollment.rst +++ b/docs/en_us/course_authors/source/running_course/course_enrollment.rst @@ -5,7 +5,8 @@ Enrollment ########################## Course authors and instructors can enroll students in a course, see how many -people are enrolled, and, when necessary, unenroll students. +people are enrolled, and, when necessary, unenroll students on the Instructor +Dashboard. Students can enroll themselves in a course during its defined enrollment period. For a ``www.edx.org`` course, enrollment is publicly available to @@ -21,6 +22,11 @@ and students you explicitly enroll. * :ref:`unenroll_student` +Data about course enrollment is also available from edX Insights. You access +Insights from the Instructor Dashboard for your live course: after you click +**Instructor**, click the link in the banner at the top of each page. For more +information, see `Using edX Insights`_. + .. _registration_enrollment: ********************************* @@ -174,3 +180,5 @@ To unenroll students, you supply the email addresses of enrolled students. **Current Courses** dashboards, and the students can no longer contribute to discussions or the wiki or access the courseware. + +.. _Using edX Insights: http://edx-insights.readthedocs.org/en/latest/ \ No newline at end of file diff --git a/docs/en_us/data/source/internal_data_formats/change_log.rst b/docs/en_us/data/source/internal_data_formats/change_log.rst index eaa74ea4ca..f9e80cfd76 100644 --- a/docs/en_us/data/source/internal_data_formats/change_log.rst +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -1,9 +1,17 @@ .. _Change Log: -********** +########### Change Log -********** +########### +.. ********************** +.. October-December 2014 +.. ********************** + + +********************** +July-September 2014 +********************** .. list-table:: :widths: 10 70 @@ -11,6 +19,9 @@ Change Log * - Date - Change + * - 09/30/14 + - Added information about the data that is available to course teams to + the :ref:`Package` chapter. * - 09/18/14 - Added descriptions of two columns added to the :ref:`auth_userprofile table`. @@ -38,6 +49,18 @@ Change Log * - 07/10/14 - Added the :ref:`Getting_Credentials_Data_Czar` chapter with information to help new data czars set up credentials for secure data transfers. + + +********************** +April-June 2014 +********************** + +.. list-table:: + :widths: 10 70 + :header-rows: 1 + + * - Date + - Change * - 06/27/14 - Made a correction to the ``edx.forum.searched`` event name in the :ref:`Tracking Logs` chapter. @@ -85,6 +108,18 @@ Change Log data packages. * - 04/25/14 - Added new event types to the :ref:`Tracking Logs` chapter for interactions with PDF files. + + +********************** +January-March 2014 +********************** + +.. list-table:: + :widths: 10 70 + :header-rows: 1 + + * - Date + - Change * - 03/31/14 - Added new fields for the server ``problem_check`` event type to the :ref:`Tracking Logs` chapter. * - diff --git a/docs/en_us/data/source/internal_data_formats/package.rst b/docs/en_us/data/source/internal_data_formats/package.rst index 3641b87ece..2bafeb42f8 100644 --- a/docs/en_us/data/source/internal_data_formats/package.rst +++ b/docs/en_us/data/source/internal_data_formats/package.rst @@ -18,6 +18,13 @@ for all of their organizations' edx.org and edge.edx.org courses. * :ref:`Data Package Contents` +Course-specific data is also available to the members of individual course +teams. Users who are assigned the Instructor or Course Staff role can view and +download data from the Instructor Dashboard in their live courses and from edX +Insights. The data available to course teams from these applications is a +subset of the data available in the data packages. For more information, see +`Building and Running an edX Course`_ and `Using edX Insights`_. + .. _Data Package Files: ********************** @@ -288,4 +295,9 @@ following set of sql and mongo database files. ``{org}-{course}-{date}-wiki_articlerevision-{site}-analytics.sql`` Changes and deletions affecting course wiki articles. See - :ref:`wiki_articlerevision`. \ No newline at end of file + :ref:`wiki_articlerevision`. + + + +.. _Using edX Insights: http://edx-insights.readthedocs.org/en/latest/ +.. _Building and Running an edX Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/ \ No newline at end of file diff --git a/docs/en_us/shared/browsers.rst b/docs/en_us/shared/browsers.rst index 4543c9bdea..ef9af38b4e 100644 --- a/docs/en_us/shared/browsers.rst +++ b/docs/en_us/shared/browsers.rst @@ -1,5 +1,7 @@ .. _Browsers: +.. Doc team! Be sure that when you make any changes to this file that you also make them to the mirrored file in the edx-analytics-dashboard/docs repository. - Alison 19 Sep 14 + #################### edX Browser Support #################### @@ -78,3 +80,34 @@ The following table shows operating system and browser support for edX Studio, w - Yes - N/A - N/A + +*********************************** +edX Insights +*********************************** + +The following table shows operating system and browser support for edX +Insights, which staff use to review and download data about their courses and +students. + +.. list-table:: + :widths: 20 10 10 10 10 10 + :header-rows: 1 + + * - + - Chrome + - Safari + - Firefox + - IE 9 + - IE 10 + * - Windows 7 + - Yes + - N/A + - Yes + - Provisional + - Provisional + * - Mac OSX 10.8 or 10.9 + - Yes + - Yes + - Yes + - N/A + - N/A \ No newline at end of file diff --git a/docs/en_us/shared/preface.rst b/docs/en_us/shared/preface.rst index 9d369f1f85..a61ceb4c7e 100644 --- a/docs/en_us/shared/preface.rst +++ b/docs/en_us/shared/preface.rst @@ -54,6 +54,12 @@ Documentation for course teams is available on the docs.edx.org web page. When you are working in edX Studio, you can access relevant sections of this guide by clicking **Help** on any page. +* `Using edX Insights`_ describes the metrics, visualizations, and downloadable + .csv files that course teams can use to gain information about student + background and activity. + +.. about student background, activity, and progress. + * `edX Course Staff Release Notes`_ summarize the changes in each new version of the edX Studio and LMS software. @@ -109,8 +115,8 @@ version, click **v: latest** at the lower left of the page, and then click Email ------- -To receive and share information by email, researchers can join the -`openedx-analytics`_ Google group to ask questions and participate in +To receive and share information by email, researchers can join the +`openedx-analytics`_ Google group to ask questions and participate in discussions with peers at other edX partner organizations and edX staffers. Wiki @@ -149,10 +155,12 @@ Documentation for developers is available on the docs.edx.org web page. GitHub ------- -There are two main edX repositories on GitHub. +These are the main edX repositories on GitHub. * The `edx/edx-platform`_ repo contains the code for the edX platform. +* The `edx/edx-analytics-dashboard`_ repo contains the code for edX Insights. + * The `edx/configuration`_ repo contains scripts to set up and operate the edX platform. @@ -167,8 +175,8 @@ To receive and share information by email, developers can join these Google groups to ask questions and participate in discussions with peers and edX staffers. -* For conversations about the code in Open edX, join `edx-code`_. -* For conversations about running Open edX, join `openedx-ops`_. +* For conversations about the code in Open edX, join `edx-code`_. +* For conversations about running Open edX, join `openedx-ops`_. * For conversations about globalization and translation, join `openedx-translation`_. Additional Google groups are occasionally formed for individual projects. @@ -232,16 +240,17 @@ edX Global Community meetup_ group. .. _Building and Running an edX Course: http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/ +.. _Using edX Insights: http://edx-insights.readthedocs.org/en/latest/ .. _edX Course Staff Release Notes: http://edx.readthedocs.org/projects/edx-release-notes/en/latest/ .. _Creating a Peer Assessment: http://edx.readthedocs.org/projects/edx-open-response-assessments/en/latest/ .. _edX Research Guide: http://edx.readthedocs.org/projects/devdata/en/latest/ -.. _newsletters: http://edx.us5.list-manage.com/subscribe?u=1822a33c054dc20e223ca40e2&id=aba723f1aa +.. _newsletters: http://edx.us5.list-manage.com/subscribe?u=1822a33c054dc20e223ca40e2&id=aba723f1aa .. _release: http://edx.us5.list-manage2.com/subscribe?u=1822a33c054dc20e223ca40e2&id=83e46bd293 .. _openedx-studio: http://groups.google.com/forum/#!forum/openedx-studio .. _Twitter: http://twitter.com/edXstatus .. _edX Status: http://status.edx.org/ .. _Open edX Product: https://edx-wiki.atlassian.net/wiki/display/OPENPROD/Open+edX+Product+Home -.. _Open edX Public Product Roadmap: https://openedx.atlassian.net/wiki/display/PROD/Product+Roadmap +.. _Open edX Public Product Roadmap: https://edx-wiki.atlassian.net/wiki/display/OPENPROD/Open+edX+Public+Product+Roadmap .. _edX Author Support: http://help.edge.edx.org/home .. _openedx-analytics: http://groups.google.com/forum/#!forum/openedx-analytics .. _Open edX Analytics: http://edx-wiki.atlassian.net/wiki/display/OA/Open+edX+Analytics+Home @@ -253,6 +262,7 @@ edX Global Community meetup_ group. .. _edx/configuration: http://github.com/edx/configuration/wiki .. _site: http://code.edx.org/ .. _edx/edx-platform: https://github.com/edx/edx-platform +.. _edx/edx-analytics-dashboard: https://github.com/edx/edx-analytics-dashboard .. _dashboard: http://dash.openedx.org/age.html .. _Demo: http://www.edx.org/course/edx/edx-edxdemo101-edx-demo-1038 .. _frequently: http://www.edx.org/student-faq