Commit 2d7d3bf2 by Alison Hodges

Merge pull request #3521 from edx/ahodges/documentation/DOC239

Documents in data packages are in raw format, not compressed or minified
parents 00d52e39 dd71ee51
......@@ -10,6 +10,9 @@ Change Log
* - Date
- Change
* - 29 Apr 14
- Corrected misstatement on how :ref:`Discussion Forums Data` is sent in
data packages.
* - 25 Apr 14
- Added new event types to the :ref:`Tracking Logs` chapter for interactions with PDF files.
* - 31 Mar 2014
......
......@@ -22,12 +22,16 @@ A sample of the field/value pairs that are in the mongo file, and descriptions o
Samples
*********
Two sample rows, or JSON documents, from a .mongo file of discussion data follow. The JSON documents are minified before they are added to the log file, so they appear in compact format.
Two sample rows, or JSON documents, from a ``.mongo`` file of discussion data
follow.
----------------------------------------
CommentThread Document Example
----------------------------------------
The JSON documents that include discussion data are delivered in a compact,
machine-readable format that can be difficult to read at a glance.
.. code-block:: json
{ "_id" : { "$oid" : "50f1dd4ae05f6d2600000001" }, "_type" : "CommentThread", "anonymous" :
......@@ -42,7 +46,8 @@ CommentThread Document Example
1358134453862 }, "votes" : { "count" : 1, "down" : [], "down_count" : 0, "point" : 1, "up" :
[ "48" ], "up_count" : 1 } }
If you use a JSON formatter to "pretty print" this document, a version that is more readable is produced.
If you use a JSON formatter to "pretty print" this document, a version that is
more readable is produced.
.. code-block:: json
......
......@@ -19,7 +19,9 @@ The sections in this chapter describe:
Sample Event
*************************
A sample event from an edX.log file follows. The JSON documents that include the event data are included in the log file as raw data, so they appear in this compact format.
A sample event from an edX.log file follows. The JSON documents that include
event data are delivered in a compact, machine-readable format that can be
difficult to read at a glance.
.. code-block:: json
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment