Merge pull request #215 from edx/ahodges/front_matter

Added reorganized front matter section, fixes DOC-1702
openedx · Mar 16, 2015 · 7942e45 · 7942e45
2 parents 906f29d + c0bc7fb
commit 7942e45
Show file tree

Hide file tree

Showing 67 changed files with 425 additions and 68 deletions.
diff --git a/...thors/source/getting_started/browsers.rst → ..._authors/source/front_matter/browsers.rst b/...thors/source/getting_started/browsers.rst → ..._authors/source/front_matter/browsers.rst
diff --git a/en_us/course_authors/source/change_log.rst → ...uthors/source/front_matter/change_log.rst b/en_us/course_authors/source/change_log.rst → ...uthors/source/front_matter/change_log.rst
diff --git a/en_us/course_authors/source/front_matter/index.rst b/en_us/course_authors/source/front_matter/index.rst
@@ -0,0 +1,13 @@
+.. _Front Matter:
+
+#############################
+For Your Information
+#############################
+
+.. toctree::
+   :maxdepth: 2
+
+   read_me
+   preface
+   change_log
+   browsers
diff --git a/en_us/course_authors/source/front_matter/preface.rst b/en_us/course_authors/source/front_matter/preface.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/preface.rst
diff --git a/en_us/course_authors/source/read_me.rst → ...e_authors/source/front_matter/read_me.rst b/en_us/course_authors/source/read_me.rst → ...e_authors/source/front_matter/read_me.rst
diff --git a/en_us/course_authors/source/getting_started/index.rst b/en_us/course_authors/source/getting_started/index.rst
@@ -8,7 +8,6 @@ Getting Started
    :maxdepth: 3
 
 
-   browsers
    accounts
    get_started
    accessibility
diff --git a/en_us/course_authors/source/index.rst b/en_us/course_authors/source/index.rst
@@ -11,9 +11,7 @@ Building and Running an edX Course
    :numbered:
    :maxdepth: 2
 
-   read_me
-   preface
-   change_log
+   front_matter/index
    getting_started/index
    building_course/index
    developing_course/index

diff --git a/en_us/course_authors/source/preface.rst b/en_us/course_authors/source/preface.rst
diff --git a/en_us/data/source/browsers.rst b/en_us/data/source/browsers.rst
diff --git a/en_us/data/source/front_matter/browsers.rst b/en_us/data/source/front_matter/browsers.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/browsers.rst
diff --git a/en_us/data/source/front_matter/change_log.rst b/en_us/data/source/front_matter/change_log.rst
@@ -0,0 +1,229 @@
+.. _Change Log:
+
+###########
+Change Log
+###########
+
+**********************
+January-March 2015
+**********************
+
+.. list-table::
+   :widths: 20 70
+   :header-rows: 1
+
+   * - Date
+     - Change
+   * - 11 Mar 2015
+     - Added information about additional video interaction events that are
+       now emitted by the edX mobile app, and reorganized the :ref:`video` in
+       the Tracking Logs chapter.
+   * - 5 Mar 2015
+     - Added new events for contributions to discussion forums to the
+       :ref:`Tracking Logs` chapter.
+   * - 
+     - Added events for the display of :ref:`Google components<content>` to the
+       Tracking Logs chapter.
+   * - 3 Mar 2015
+     - Updated the :ref:`Preface` to include information about the :ref:`The
+       edX Partner Portal` and the :ref:`The Open edX Portal`.
+   * - 23 Feb 2015
+     - Added new common fields for HTTP header values and new events for video
+       caption use to the :ref:`Tracking Logs` chapter.
+   * - 13 Feb 2015
+     - Added the ``edx.course.enrollment.mode_changed`` event to the
+       :ref:`Tracking Logs` chapter.
+   * - 4 Feb 2015
+     - Added information about the ``module.usage_key`` member field in the
+       common ``context`` field to the :ref:`Tracking Logs` chapter.
+   * - 16 Jan 2015
+     - Added the :ref:`Institution_Data` chapter with information about the
+       CSV file of student email preference settings.
+
+**********************
+October-December 2014
+**********************
+
+.. list-table::
+   :widths: 10 70
+   :header-rows: 1
+
+   * - Date
+     - Change
+   * - 12/24/14
+     - Added information about video events that the edX mobile app emits to
+       the :ref:`Tracking Logs` chapter.
+   * - 12/18/14
+     - Updated descriptions of the video events in the
+       :ref:`Tracking Logs` chapter.
+   * - 11/26/14
+     - Expanded the background information on content experiments in
+       :ref:`AB_Event_Types`.
+   * - 11/13/14
+     - Updated the ``student_courseenrollment.mode`` description.
+   * - 11/5/14
+     - Corrected descriptions for ``play_video`` and ``pause_video`` in
+       :ref:`video`.
+   * - 10/28/14
+     - Added best practices for passphrases to the
+       :ref:`Getting_Credentials_Data_Czar` chapter.
+   * - 10/23/14
+     - Added examples of the format used to identify course components to the
+       :ref:`Student_Info` and :ref:`Tracking Logs` chapters.
+   * - 
+     - Updated the ``child_render`` event to reflect the name change for the
+       ``child_id`` member field. See :ref:`Tracking Logs`.
+   * - 10/20/14
+     - Updated the :ref:`Package` chapter to remove instructions for
+       downloading weekly event files.
+   * - 10/16/14
+     - Updated video events with new fields relating to mobile device use in
+       the :ref:`Tracking Logs` chapter.
+   * - 10/07/14
+     - Added new student and instructor events relating to cohort use to the
+       :ref:`Tracking Logs` chapter.
+   * - 
+     - Removed information about XML course formats. See the `edX Open
+       Learning XML Guide <http://edx-open-learning-
+       xml.readthedocs.org/en/latest/index.html>`_ for information about
+       building XML courses.
+
+
+**********************
+July-September 2014
+**********************
+
+.. list-table::
+   :widths: 10 70
+   :header-rows: 1
+
+   * - 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<auth_userprofile>`.
+   * - 09/08/14
+     - Added cautions to the :ref:`Getting_Credentials_Data_Czar` chapter.
+   * - 09/04/14
+     - Updated the :ref:`Discussion Forums Data` chapter to include the
+       ``thread_type`` field for CommentThreads and the ``endorsement`` field
+       for Comments.
+   * - 08/25/14
+     - Removed information on course grading. See `Establishing a Grading
+       Policy <http://edx.readthedocs.org/projects/edx-partner-course-
+       staff/en/latest/building_course/establish_grading_policy.html>`_ in
+       *Building and Running an edX Course*.
+   * -
+     - Removed information on the XML for drag and drop. See `Drag and Drop
+       Problems <http://edx.readthedocs.org/projects/edx-partner-course-
+       staff/en/latest/exercises_tools/drag_and_drop.html>`_ in *Building and
+       Running an edX Course*.
+   * - 08/12/14
+     - Added the :ref:`ora2` section to the :ref:`Tracking Logs` chapter.
+   * - 08/01/14
+     - Added the :ref:`Package` chapter with information to help data czars
+       locate and download data package files.
+   * - 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.
+   * - 
+     - Added the ``stop_video`` event to the :ref:`Tracking Logs` chapter.
+   * - 
+     - Updated the ``seek_video`` event in the :ref:`Tracking Logs` chapter.
+   * - 06/23/14
+     - Added a `Preface`_ with resources for course teams, developers,
+       researchers, and students.
+   * - 05/23/14
+     - Added descriptions of the enrollment upgrade events to the
+       :ref:`Tracking Logs` chapter.
+   * - 05/22/14
+     - Added descriptions of five video- and problem-related events to the
+       :ref:`Tracking Logs` chapter.
+   * - 
+     - Added the new ``edx.forum.searched`` event to the
+       :ref:`Tracking Logs` chapter.
+   * - 05/06/14
+     - Added enrollment event types to the :ref:`Tracking Logs` chapter. 
+   * - 05/05/14
+     - Removed information on the Poll module. See `Polls 
+       <http://edx.readthedocs.org/projects/edx-partner-course-
+       staff/en/latest/exercises_tools/poll.html>`_ in *Building and Running an
+       edX Course*.
+   * -
+     - Removed information on the Word Cloud tool. See `Word Cloud tool 
+       <http://edx.readthedocs.org/projects/edx-partner-course-
+       staff/en/latest/exercises_tools/word_cloud.html>`_ in *Building and
+       Running an edX Course*.
+   * - 
+     - Removed information on CustomResponse XML and Python Script. See `Write-
+       Your-Own-Grader Problem <http://edx.readthedocs.org/projects/edx-
+       partner-course-staff/en/latest/exercises_tools/custom_python.html>`_ in
+       the  *Building and Running an edX Course* guide.
+   * - 
+     - Removed information on Formula Equation Input. See `Create a Math
+       Expression Input Problem <http://edx.readthedocs.org/projects/edx-
+       partner-course-
+       staff/en/latest/exercises_tools/math_expression_input.html>`_ in the
+       *Building and Running an edX Course* guide.
+   * - 04/29/14
+     - Corrected misstatement on how :ref:`Discussion Forums Data` is sent in
+       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.
+   * -
+     - Reformatted the :ref:`Tracking Logs` chapter to improve readability.
+   * - 03/28/14
+     - Added the :ref:`Data_Czar` chapter.
+   * - 03/24/14
+     - Added the ``user_api_usercoursetag`` table to the :ref:`Student_Info`
+       chapter and the ``assigned_user_to_partition`` and ``child_render``
+       event types to the :ref:`Tracking Logs` chapter.
+   * - 03/19/14
+     - Provided alternative formatting for the examples in the :ref:`Discussion
+       Forums Data` chapter.
+   * - 03/13/14
+     - Updated the :ref:`Student_Info` chapter.
+   * - 02/24/14
+     - Added descriptions of new fields to the :ref:`Wiki_Data` chapter.
+   * - 02/21/14
+     - Added descriptions of new fields to the :ref:`Discussion Forums Data`
+       chapter.
+   * - 02/14/14
+     - Added the ``seek_video`` and ``speed_change_video`` event types to the
+       :ref:`Tracking Logs` chapter.
+
+.. _Preface: http://edx.readthedocs.org/projects/devdata/en/latest/preface.html
diff --git a/en_us/data/source/front_matter/index.rst b/en_us/data/source/front_matter/index.rst
@@ -0,0 +1,12 @@
+#############################
+For Your Information
+#############################
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   change_log
+   read_me
+   preface
+   browsers
diff --git a/en_us/data/source/front_matter/preface.rst b/en_us/data/source/front_matter/preface.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/preface.rst
diff --git a/en_us/data/source/read_me.rst → en_us/data/source/front_matter/read_me.rst b/en_us/data/source/read_me.rst → en_us/data/source/front_matter/read_me.rst
diff --git a/en_us/data/source/index.rst b/en_us/data/source/index.rst
@@ -7,12 +7,10 @@ teams at edX partner institutions who use the edX data exports to gain insight
 into their courses and students.
 
 .. toctree::
+   :numbered:
    :maxdepth: 2
 
-   read_me.rst
-   preface.rst
-   browsers.rst
-   internal_data_formats/change_log.rst
+   front_matter/index
    internal_data_formats/data_czar.rst
    internal_data_formats/credentials.rst
    internal_data_formats/package.rst

diff --git a/en_us/data/source/preface.rst b/en_us/data/source/preface.rst
diff --git a/en_us/developers/source/browsers.rst b/en_us/developers/source/browsers.rst
diff --git a/en_us/developers/source/front_matter/browsers.rst b/en_us/developers/source/front_matter/browsers.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/browsers.rst
diff --git a/en_us/developers/source/change_log.rst → ...lopers/source/front_matter/change_log.rst b/en_us/developers/source/change_log.rst → ...lopers/source/front_matter/change_log.rst
diff --git a/en_us/developers/source/front_matter/index.rst b/en_us/developers/source/front_matter/index.rst
@@ -0,0 +1,12 @@
+#############################
+For Your Information
+#############################
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   change_log
+   read_me
+   preface
+   browsers
diff --git a/en_us/developers/source/front_matter/preface.rst b/en_us/developers/source/front_matter/preface.rst
@@ -0,0 +1 @@
+.. include:: ../../../shared/preface.rst
diff --git a/en_us/developers/source/front_matter/read_me.rst b/en_us/developers/source/front_matter/read_me.rst
@@ -0,0 +1,19 @@
+*******
+Read Me
+*******
+
+The *edX Developer Documentation* is created using RST_ files and Sphinx_.
+You, the user community, can help update and revise this documentation project
+on GitHub::
+
+  https://github.com/edx/edx-platform/docs/en_us/data/source
+
+To suggest a revision, fork the project, make changes in your fork, and submit
+a pull request back to the original project: this is known as the `GitHub Flow`_.
+All pull requests need approval from edX. For more information, contact edX at `docs@edx.org`_.
+
+.. _docs@edx.org: docs@edx.org
+.. _Sphinx: http://sphinx-doc.org/
+.. _LaTeX: http://www.latex-project.org/
+.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser
+.. _RST: http://docutils.sourceforge.net/rst.html
diff --git a/en_us/developers/source/index.rst b/en_us/developers/source/index.rst
@@ -3,21 +3,18 @@ edX Developer's Guide
 #########################
 
 .. toctree::
-    :maxdepth: 2
-
-    preface.rst
-    change_log
-    browsers.rst
-    process/index
-    testing/index
-    extending_platform/index
-    modulestores/index
-    pavelib.rst
-    public_sandboxes.rst
-    analytics.rst
-    deploy-new-service
-    internationalization/index
-    accessibility
-    glossary
-
+   :numbered:
+   :maxdepth: 2
 
+   front_matter/index
+   process/index
+   testing/index
+   extending_platform/index
+   modulestores/index
+   pavelib.rst
+   public_sandboxes.rst
+   analytics.rst
+   deploy-new-service
+   internationalization/index
+   accessibility
+   glossary
diff --git a/en_us/developers/source/preface.rst b/en_us/developers/source/preface.rst
diff --git a/en_us/install_operations/source/browsers.rst b/en_us/install_operations/source/browsers.rst