Skip to content

Latest commit

 

History

History
107 lines (79 loc) · 5.42 KB

File metadata and controls

107 lines (79 loc) · 5.42 KB

Open edX Tutorials

Resources for getting started with the Open edX platform are provided here. They range from “Quickstarts” (step-by-step instructions to getting up and running with various areas of the Open edX software and community) to hands-on sandboxes and courses.

Try it Out!

If you've never used the Open edX software, we have a few resources to help you get acquainted:

Resources for Specific Roles

.. grid:: 1 2 2 2
  :gutter: 3
  :padding: 0

  .. grid-item-card:: Content Creators
     :class-card: sd-shadow-md sd-p-2
     :class-footer: sd-border-0

     .. image:: /_images/educators_homepage/educator_undraw.png
        :alt: Educator Persona building a course
        :height: 150px
        :align: center

     Follow the :ref:`Course Authoring Quickstart <Quick Start Build a Course>` to build your first Open edX course. Leverage the free-to-use `Studio sandbox <https://studio.sandbox.openedx.org/>`_ to follow the steps.

  .. grid-item-card:: Site Operators
     :class-card: sd-shadow-md sd-p-2
     :class-footer: sd-border-0

     .. image:: /_images/site_operators_undraw.png
        :alt: Site Operator Persona operating a site
        :height: 150px
        :align: center

     Looking to run your own Open edX instance? The :ref:`Site Ops Quickstarts` explain the basics of Tutor, the community-supported, Docker-based, Open edX distribution for production ready systems.

  .. grid-item-card:: Extending the Open edX Platform
     :class-card: sd-shadow-md sd-p-2
     :class-footer: sd-border-0

     .. image:: /_images/educators_homepage/olx_undraw.png
        :alt: A user with abstract icons around them
        :height: 150px
        :align: center

     The modular Open edX platform provides many extension points that don't require modification to the core codebase. These include:

     * :ref:`Frontend plugin "slots" <Use A Frontend Plugin Framework Slot>` for UI customization
     * :ref:`XBlocks <xblock:Open edX XBlock Tutorial>`, a composable framework to enable rapid development and pluggability of new content types
     * :ref:`Hooks Extension Framework` for modifying the platform's functionality and flows
     * :ref:`Design tokens <Design Tokens>` for theming customization

     Check out the `Sample Plugin <https://github.com/openedx/sample-plugin>`_ for documentation and examples of leveraging the various Open edX extension points.

  .. grid-item-card:: Developing the Open edX Platform
     :class-card: sd-shadow-md sd-p-2
     :class-footer: sd-border-0

     .. image:: /_images/developers_undraw.png
        :alt: Developer Persona enhancing the platform
        :height: 150px
        :align: center

     Two quickstarts are provided for developers looking to jump in and contribute to the open-source Open edX project. The :ref:`Pull Request Quickstart <qs Dev First PR>` goes through the GitHub “pull request” workflow all developers who contribute must follow. You’ll learn how to set up a development environment and at the end will have made your first pull request to the project.

     The :ref:`Contributing Quickstart <qs Dev Contributing>` builds on the Pull Request Quickstart to guide you through the process of making a more substantial change to the platform. It discusses both technical and product considerations.

     The `Open edX contribution course <https://apps.training.openedx.io/catalog/courses/course-v1:OpenedX+OEX101+2023/about>`_ and the `Developer onboarding course <https://apps.training.openedx.io/catalog/courses/course-v1:OpenedX+OEX-Dev101+2024/about>`_ are additional, helpful resources.

Questions?

Find the Open edX community on the Community Discussion Boards and the Slack Workspace!

Maintenance chart

Review Date Working Group Reviewer Release Test situation
2026-03-20 Product WG Verawood Pass