index.rst 1.72 KB
Newer Older
1 2 3 4 5 6 7 8
..
    Public facing docs for non-developers go here. Please do not add any Python
    dependencies for code introspection here (we may temporarily host it some
    place where those dependencies are cumbersome to build).

edX Data Documentation
======================
The following documents are targetted at those who are working with various data formats consumed and produced by the edX platform -- primarily course authors and those who are conducting research on data in our system. Developer oriented discussion of architecture and strictly internal APIs should be documented elsewhere.
9

10 11 12 13 14 15 16
Course Data Formats
-------------------
These are data formats written by people to specify course structure and content. Some of this is abstracted away if you are using the Studio authoring user interface.

.. toctree::
   :maxdepth: 2

17 18
   course_data_formats/course_xml.rst
   course_data_formats/grading.rst
19

20 21 22 23 24 25 26
Specific Problem Types
^^^^^^^^^^^^^^^^^^^^^^
.. toctree::
   :maxdepth: 1

   course_data_formats/drag_and_drop/drag_and_drop_input.rst
   course_data_formats/graphical_slider_tool/graphical_slider_tool.rst
27 28
   course_data_formats/poll_module/poll_module.rst
   course_data_formats/conditional_module/conditional_module.rst
29
   course_data_formats/word_cloud/word_cloud.rst
30
   course_data_formats/custom_response.rst
31 32


33 34
Internal Data Formats
---------------------
35 36 37 38 39
These document describe how we store course structure, student state/progress, and events internally. Useful for developers or researchers who interact with our raw data exports.

.. toctree::
   :maxdepth: 2

40 41 42
   internal_data_formats/sql_schema.rst
   internal_data_formats/discussion_data.rst
   internal_data_formats/tracking_logs.rst
43 44 45 46 47 48

Indices and tables
==================

* :ref:`search`