Commit fc89ccaa by Alison Hodges

Corrected link to Developer's guide

@mhoeber , @stroilova
parent 8b73de91
...@@ -70,13 +70,13 @@ file. This file can be useful for validation and debugging. ...@@ -70,13 +70,13 @@ file. This file can be useful for validation and debugging.
Documenting Events Documenting Events
******************* *******************
The *edX Platform Developer Documentation* provides guidelines for `Contributing The *edX Platform Developer's Guide* provides guidelines for `Contributing to
to Open edX Open edX <http://edx.readthedocs.org/projects/edx-developer-
<http://edx.readthedocs.org/projects/userdocs/en/latest/process/index.html>`_`. guide/en/latest/process/index.html>`_. As part of your effort to add events to
As part of your effort to add events to the platform, consider including the platform, consider including comments that identify the purpose of the
comments that identify the purpose of the events and the fields emitted for events and the fields emitted for them. A description can assure that
them. A description can assure that researchers and other members of the open researchers and other members of the open edX community understand your intent
edX community understand your intent and use the event correctly. and use the event correctly.
The `edX Research Guide The `edX Research Guide
<http://edx.readthedocs.org/projects/devdata/en/latest/>`_ includes reference <http://edx.readthedocs.org/projects/devdata/en/latest/>`_ includes reference
...@@ -85,7 +85,10 @@ information for emitted events that are included in tracking logs. ...@@ -85,7 +85,10 @@ information for emitted events that are included in tracking logs.
Request Context Middleware 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``.
Legacy Application Event Processor Legacy Application Event Processor
********************************** **********************************
......
...@@ -87,7 +87,9 @@ ...@@ -87,7 +87,9 @@
.. _Data Delivered in Data Packages: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/package.html .. _Data Delivered in Data Packages: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/package.html
.. _edX Developer's Guide: http://edx.readthedocs.org/projects/edx-developer-guide/en/latest/index.html
.. _edX Platform Developer's Guide: http://edx.readthedocs.org/projects/edx-developer-guide/en/latest/
.. _Keys and Credentials for Data Transfers: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/credentials.html .. _Keys and Credentials for Data Transfers: http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/credentials.html
......
...@@ -140,7 +140,7 @@ Documentation ...@@ -140,7 +140,7 @@ Documentation
Documentation for developers is available on the docs.edx.org web page. 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 platform python docstrings. The topics in this guide include guidelines for
contributing to Open edX, options for extending the Open edX platform, using contributing to Open edX, options for extending the Open edX platform, using
the edX public sandboxes, instrumenting analytics, and testing. the edX public sandboxes, instrumenting analytics, and testing.
...@@ -152,7 +152,9 @@ Documentation for developers is available on the docs.edx.org web page. ...@@ -152,7 +152,9 @@ Documentation for developers is available on the docs.edx.org web page.
* XBlock_: Open edX courseware components provides preliminary documentation * XBlock_: Open edX courseware components provides preliminary documentation
on the XBlock component architecture for building courses. 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 GitHub
------- -------
...@@ -271,7 +273,7 @@ edX Global Community meetup_ group. ...@@ -271,7 +273,7 @@ edX Global Community meetup_ group.
.. _Open Source Home: http://edx-wiki.atlassian.net/wiki/display/OS/Open+Source+Home .. _Open Source Home: http://edx-wiki.atlassian.net/wiki/display/OS/Open+Source+Home
.. _XBlock: http://edx.readthedocs.org/projects/xblock/en/latest/ .. _XBlock: http://edx.readthedocs.org/projects/xblock/en/latest/
.. _Installing, Configuring, and Running the edX Platform: http://edx.readthedocs.org/projects/edx-installing-configuring-and-running/en/latest/ .. _Installing, Configuring, and Running the edX Platform: http://edx.readthedocs.org/projects/edx-installing-configuring-and-running/en/latest/
.. _edX Developer Documentation: http://edx.readthedocs.org/projects/userdocs/en/latest/ .. _edX Platform Developer's Guide: http://edx.readthedocs.org/projects/edx-developer-guide/en/latest/
.. _edx/configuration: http://github.com/edx/configuration/wiki .. _edx/configuration: http://github.com/edx/configuration/wiki
.. _site: http://code.edx.org/ .. _site: http://code.edx.org/
.. _edx/edx-platform: https://github.com/edx/edx-platform .. _edx/edx-platform: https://github.com/edx/edx-platform
......
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