Skip to main content
Ctrl+K
Logo image

User Home Pages

  • Community
    • Open edX Platform Release Notes
      • Palm: The current release
      • Open edX Named Release Branches and Tags
      • Older Open edX Releases
        • Open edX Olive Release
        • 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
      • Configuring Google Analytics
    • Site Operators: Concepts
    • Site Operators: References
  • Developers
    • Maintainers Home
  • 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: Palm
  • All Release Notes
    • Palm: The current release
    • Open edX Named Release Branches and Tags
    • Older Open edX Releases
      • Open edX Olive Release
      • 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
    • Importing and Exporting a Course
    • Course re-runs
    • 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
    • Add Content in an Iframe
    • Copy and Paste Course Content
    • Manage Course Files
    • Add Course Updates and Hand-outs
    • Importing SCORM Content
    • Using LTI
    • Leveraging Libraries
    • 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
    • Add an In-Video Quiz
    • Create Course-Wide Discussion Topics
    • Create Content-Specific Discussion Topics
    • Enable/Disable 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
    • Configuring Google Analytics
  • 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 Javascript Upgrade Automation
    • How To Enable Python Upgrade Automation
    • How To Get Ready for Frontend Development
    • How-to get your repository docs on docs.openedx.org
    • How To Maintain a Repository
    • Ongoing Maintainer’s Tasks
    • How to Switch to the sphinx-book-theme for Documentation
    • How to Set Up Github Action to Monitor Python Coverage
  • Concepts
    • Open edX Accessibility Concepts
    • Backend Layout and Approach
    • OEP-58 Overview
    • Platform Overview
  • Reference
    • Running Pull Request Tests
    • Tools for Maintainers
    • Open edX Accessibility Reference
    • 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
    • Open edX Developer’s Guide
      • 1. General Information
        • 1.1. Open edX Browser Support
      • 2. Open edX Architecture
      • 3. Contributing to Open edX
        • 3.1. Process for Contributing Code
        • 3.2. Contributing
        • 3.3. Code Considerations
        • 3.4. Core Contributors to the Open edX Project
      • 4. Extending the edX Platform
        • 4.1. Options for Extending the edX Platform
        • 4.2. Integrating XBlocks with edx-platform
      • 5. Testing
        • 5.1. GitHub Actions
        • 5.2. Code Coverage
        • 5.3. Code Quality
      • 6. Analytics
      • 7. Writing Good Code
        • 7.1. Django Good Practices
      • 8. Writing Code for Internationalization
        • 8.1. Internationalization Coding Guidelines
      • 9. Preventing Cross Site Scripting Vulnerabilities
        • 9.1. Preventing Cross Site Scripting Vulnerabilities
        • 9.2. Preventing XSS by Stripping HTML Tags
        • 9.3. Preventing XSS in Django Templates
        • 9.4. Preventing XSS in React
      • 10. Language Style Guidelines
        • 10.1. JavaScript Style Guide
        • 10.2. Open edX Python Style Guide
        • 10.3. EdX Sass Style Guide
      • 11. Glossary
    • Glossary

Documentors

  • Quickstarts
    • Quick Start: First Documentation PR
    • Quick Start: Add New Documentation Through GitHub
    • Quick Start: Update Existing Docs Through GitHub
  • How-tos
    • Add New Documentation via GitHub
    • Make Changes to your Pull Request
    • Update An Existing 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
    • 5. Use Markdown READMEs for repos published to npm

Open edX Wiki
Open edX website
Cookie Policy
  • Repository
  • Suggest edit
  • Open issue
  • .rst

Documentation Decisions

Documentation Decisions#

  • 1. Purpose of this Repo
  • 2. Choosing RST
  • 3. Documentation Layout
  • 4. Don't Use AutoSectionLabel Extension
  • 5. Use Markdown READMEs for repos published to npm

Feedback

previous

Getting Help

next

Purpose of This Repo

© Copyright 2023, Axim Collaborative.