Documentation

The Open edX platform is not just software. It’s also a complete product with extensive documentation.

Release notes

Access Hawthorn Release here.

Users

Documentation for Open edX users who are following the master version of the platform. These guides can include changes made after the Ginkgo release.

Installing, Configuring, & Running the Open edX Platform

Instructions for system administrators setting up an Open edX installation.

Building and Running a Course

Instructions for course teams creating courses to run on an Open edX site.

Learner’s Guide

Help for learners taking an Open edX course.

Open Learning XML Guide

References for course teams using open learning XML (OLX) to build courses.

Using edX Insights

Descriptions of the visualizations, metrics, and tables that present edx.org course data to course teams.

Developers

Guidelines and resources for developers extending and contributing to the Open edX platform.

Developer’s Guide

References for developers contributing to the edX platform.

XBlock API Guide

API information for developers extending Open edX with XBlocks.

Data Analytics API

Documentation for the Open edX Data Analytics REST API.