From fc89ccaa6dc89e72381caa679e052856f0134fa9 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Tue, 28 Oct 2014 17:35:10 -0400 Subject: [PATCH] Corrected link to Developer's guide @mhoeber , @stroilova --- docs/en_us/developers/source/analytics.rst | 19 +++++++++++-------- docs/en_us/release_notes/source/links.rst | 4 +++- docs/en_us/shared/preface.rst | 8 +++++--- 3 files changed, 19 insertions(+), 12 deletions(-) diff --git a/docs/en_us/developers/source/analytics.rst b/docs/en_us/developers/source/analytics.rst index 84ccede99b..f9502fe571 100644 --- a/docs/en_us/developers/source/analytics.rst +++ b/docs/en_us/developers/source/analytics.rst @@ -70,13 +70,13 @@ file. This file can be useful for validation and debugging. Documenting Events ******************* -The *edX Platform Developer Documentation* provides guidelines for `Contributing -to Open edX -`_`. -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 `_. 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 `_ 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``. Legacy Application Event Processor ********************************** diff --git a/docs/en_us/release_notes/source/links.rst b/docs/en_us/release_notes/source/links.rst index 9d25afcb04..c6e0043118 100644 --- a/docs/en_us/release_notes/source/links.rst +++ b/docs/en_us/release_notes/source/links.rst @@ -87,7 +87,9 @@ .. _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 diff --git a/docs/en_us/shared/preface.rst b/docs/en_us/shared/preface.rst index 2e5fe7bb85..350ed5a0c5 100644 --- a/docs/en_us/shared/preface.rst +++ b/docs/en_us/shared/preface.rst @@ -140,7 +140,7 @@ Documentation 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. .. _Open Source Home: http://edx-wiki.atlassian.net/wiki/display/OS/Open+Source+Home .. _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/ -.. _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 .. _site: http://code.edx.org/ .. _edx/edx-platform: https://github.com/edx/edx-platform