logo
  • Open edX Documentation

User Home Pages

  • Community
    • Open edX Platform Release Notes
      • Olive: The current release
      • Open edX Named Release Branches and Tags
      • Older Open edX Releases
        • Open edX Nutmeg Release
        • Open edX Maple Release
        • Open edX Lilac Release
        • Open edX Koa Release
        • Open edX Juniper Release
        • Open edX Ironwood Release
        • Open edX Hawthorn Release
        • Open edX Ginkgo Release
        • Open edX Ficus Release
        • Open edX Eucalyptus Release
        • Open edX Dogwood Release
        • Open edX Cypress Release
        • Open edX Birch Release
  • Educators
  • Course Operators
  • Site Operators
    • Site Operators: Quick Start
    • Site Operators: How-tos
    • Site Operators: Concepts
    • Site Operators: References
  • Developers
  • Documentors
  • Translators
    • Get Started as a Translator
      • Quick Start: How to start translating for Open edX
    • How to join a review team
    • How to join a translation team
    • How to request a new language for translation
    • Working With HTML
    • Working With Placeholders
    • Translators: Reference

Quick Starts

  • Educators: Build a Course
  • Course Operators: Run a Course
  • Site Operators: Set up Open edX
  • Developers: Contribute to Open edX
    • Quick Start: First Open edX Pull Request
  • Documentors: First Documentation PR

Open Source Community

  • Current Release: Olive
  • All Release Notes
    • Olive: The current release
    • Open edX Named Release Branches and Tags
    • Older Open edX Releases
      • Open edX Nutmeg Release
      • Open edX Maple Release
      • Open edX Lilac Release
      • Open edX Koa Release
      • Open edX Juniper Release
        • 1. Juniper release notes: Learner Experiences
        • 2. Juniper release notes: Educator Experiences
        • 3. Juniper release notes: Developer Experiences
      • Open edX Ironwood Release
      • Open edX Hawthorn Release
      • Open edX Ginkgo Release
      • Open edX Ficus Release
      • Open edX Eucalyptus Release
        • Enabling the Bulk Email Feature
        • Replacing the courseware_studentmodulehistory Table
      • Open edX Dogwood Release
      • Open edX Cypress Release
      • Open edX Birch Release
  • How to Contribute
  • OEPs (Open edX Proposals): Community Decision Documents

Educators: Build an Open edX Course

  • Quickstarts
  • How-tos
    • Create a Course
    • Add Course Creators
    • Schedule a Course
    • Create the Course About Page
    • Set Up Course Prerequisites
    • Set Up Certificates
    • Open the Course Outline
    • Create a Section
    • Create a Subsection
    • Add the Course Structure
    • Add Units to the Outline
    • Reorganize the Course Outline
    • Delete Content
    • Add Written Content
    • Add an Image
    • Manage Course Files
    • Prepare Videos
    • Set Up a Hosting Service
    • Create a Video
    • Get a Video Transcript
    • Add a Transcript in Another Language
    • Add a YouTube Video
    • Enable Video and Transcript Downloads
    • Add a Checkbox Problem
    • Add a Dropdown Problem
    • Add a Multiple Choice Problem
    • Add a Numerical Input Problem
    • Add a Text Input Problem
    • Add a Custom JavaScript Display and Grading Problem
    • Add a Write-Your-Own-Grader Problem
    • Add a Math Expression Input Problem
    • Add an Open Response Assessment
    • Create Course-Wide Discussion Topics
    • Create Content-Specific Discussion Topics
    • Allow Anonymous Discussion Posts
    • Set Release Dates
    • Publish Content
    • Hide Content from Learners
    • Set Up Content Groups
    • Set Access Restrictions on a Unit
    • Set Access Restrictions on a Component
    • Set the Grading Policy
    • Set a Subsection to be Graded
    • Add a Course Page
    • Reorder Course Pages
    • Hide a Course Page
    • Preview Draft Content
    • View Your Course
    • View Your Course as a Learner
    • Beta Test Your Course
  • Concepts
    • Instructional Design Concepts
      • Instructional Design Overview
      • The Course Development Process
      • Instructional Design Templates
  • Reference
    • Complex Problem Types
    • Course Dates
    • Course Pacing
    • Course Sections
    • Course Subsections
    • Course Units
    • Simple Problem Types
    • User Roles
    • Instructional Design References
      • Sample Ref Doc

Course Operators: Run Open edX

  • Quickstarts
  • How-tos
  • Concepts
  • References

Site Operators: Set Up Open edX

  • Quickstarts
  • How-tos
  • Concepts
  • Reference

Software Developers: Enhance the Open edX Platform

  • Quickstarts
    • Quick Start: First Open edX Pull Request
  • How-tos
    • How To Add a Catalog File
    • How To Add Sphinx Docs to a Repo
    • How To Enable Python Upgrade Automation
    • How To Get Ready for Frontend Development
    • How To Maintain a Repository
    • How to Switch to the sphinx-book-theme for Documentation
  • Concepts
    • Backend Layout and Approach
    • Platform Overview
  • Reference
    • Running Pull Request Tests
    • Tools for Maintainers
    • Event Reference
      • Events in the Tracking Logs
        • Reviewing a Sample Event
        • Common Fields
        • Student Events
        • Course Team Events
      • xAPI Events
      • Caliper Events
      • Alphabetical Tracking Log Event List
    • Glossary

Documentors

  • Quickstarts
    • Quick Start: First Documentation PR
    • Quick Start: Add Documentation Through Github
    • Quick Start: Update Doc Through GitHub
  • How-tos
    • Add Documentation via Github
    • Make Changes to your Pull Request
    • Update A Doc via GitHub
  • Concepts
    • Documentation Content Types
    • Documentation Audiences
  • References
    • Documentation Checklist
    • Getting Started
    • Add Links in a Topic
    • Documentation Templates
    • Sample Document with Errors
    • Quick Reference: Writing RST

Translators

  • Quickstarts
    • Quick Start: How to start translating for Open edX
  • How-tos
    • How to join a review team
    • How to join a translation team
    • How to request a new language for translation
  • Concepts
    • Translations Process
    • Working With HTML
    • Working With Placeholders
  • References

Other Topics

  • Documentation Feedback Form
  • Getting Help
  • Documentation Decisions
    • 1. Purpose of this Repo
    • 2. Choosing RST
    • 3. Documentation Layout
    • 4. Don't Use AutoSectionLabel Extension


Open edX Wiki
Open edX website
Cookie Policy
  • repository
  • open issue
  • suggest edit
  • .rst
Contents
  • Per Repo Documentation
  • Other References

References Home

Contents

  • Per Repo Documentation
  • Other References

References Home#

Per Repo Documentation#

  • Welcome to DoneXBlock’s documentation!

  • Welcome to Open edX OARS’s documentation!

Other References#

  • Running Pull Request Tests
    • Tests aren’t running on my PR
    • The openedx/cla Check is Failing
    • The “Lint Commit Messages/commitlint” Test Is Failing
    • Python, Javascript, or Other Tests are Failing
    • My Python/Javascript/etc Tests Pass Locally but Fail On PR
  • Tools for Maintainers
  • Event Reference
    • Events in the Tracking Logs
    • xAPI Events
    • Caliper Events
    • Alphabetical Tracking Log Event List
  • Glossary

Feedback

previous

Platform Overview

next

Running Pull Request Tests

© Copyright 2023, The Center for Reimagining Learning.