As part of your effort to add events to the platform, consider including
comments that identify the purpose of the events and the fields emitted for
them. A description can assure that researchers and other members of the open
edX community understand your intent and use the event correctly.
The *edX Platform Developer's Guide* provides guidelines for `Contributing to
Open edX <http://edx.readthedocs.org/projects/edx-developer-
guide/en/latest/process/index.html>`_. As part of your effort to add events to
the platform, consider including comments that identify the purpose of the
events and the fields emitted for them. A description can assure that
researchers and other members of the open edX community understand your intent
and use the event correctly.
The `edX Research Guide
<http://edx.readthedocs.org/projects/devdata/en/latest/>`_ includes reference
...
...
@@ -85,7 +85,10 @@ information for emitted events that are included in tracking logs.
Request Context Middleware
**********************************
The platform includes a middleware class that enriches all events emitted during the processing of a given request with details about the request that greatly simplify downstream processing. This is called the ``TrackMiddleware`` and can be found in ``edx-platform/common/djangoapps/track/middleware.py``.
The platform includes a middleware class that enriches all events emitted
during the processing of a given request with details about the request that
greatly simplify downstream processing. This is called the ``TrackMiddleware``
and can be found in ``edx-platform/common/djangoapps/track/middleware.py``.
Documentation for developers is available on the docs.edx.org web page.
* `edX Developer Documentation`_ collects information directly from edX
* The `edX Platform Developer's Guide`_ collects information directly from edX
platform python docstrings. The topics in this guide include guidelines for
contributing to Open edX, options for extending the Open edX platform, using
the edX public sandboxes, instrumenting analytics, and testing.
...
...
@@ -152,7 +152,9 @@ Documentation for developers is available on the docs.edx.org web page.
* XBlock_: Open edX courseware components provides preliminary documentation
on the XBlock component architecture for building courses.
* `edX Open Learning XML Guide`_ provides guidelines for building edX courses with Open Learning XML (OLX). Note that this guide is currently an Alpha version.
* `edX Open Learning XML Guide`_ provides guidelines for building edX courses
with Open Learning XML (OLX). Note that this guide is currently an Alpha
version.
GitHub
-------
...
...
@@ -271,7 +273,7 @@ edX Global Community meetup_ group.
