Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 0 additions & 36 deletions source/community/how-tos/receive_announcements_by_email.rst

This file was deleted.

2 changes: 1 addition & 1 deletion source/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Community Home
release_notes/index
concepts/what_is_the_roadmap
how-tos/read_the_roadmap
references/tutorials
security_policy/index
how-tos/receive_announcements_by_email
Community Discussion Boards <https://discuss.openedx.org>
Slack Workspace <https://openedx.org/slack>
107 changes: 107 additions & 0 deletions source/community/references/tutorials.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
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:

* `Open edX Sandbox <https://sandbox.openedx.org/>`_ - sign up for a free
account to begin playing around with the Open edX learner and authoring
environments. Once you've registered for an account, access `Open edX Studio
<https://studio.sandbox.openedx.org/>`_ to try your hand at :ref:`authoring courses <Quick Start Build a Course>`
or :ref:`content libraries <Work with Content Libraries>`.
Please be aware that all accounts and content are deleted every 7 days.

* `Open edX Training Site <https://apps.training.openedx.io/catalog/>`_ - this
site provides free courses for those interested in learning more about the
Open edX community and getting started as an Open edX developer. The `Demo
Course
<https://apps.training.openedx.io/catalog/courses/course-v1:OpenedX+DemoX+Demo_Course/about>`_
steps you through various types of Open edX content tools and introduces the
course authoring environment, Studio.

* :ref:`Aspects Data <openedx-aspects:Aspects Home>` -
learn more about Aspects, the Open edX analytics plugin that brings course
teams and site operators actionable data about learner engagement, content
performance, and instance health.

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 <https://discuss.openedx.org>`_ and the `Slack Workspace <https://openedx.org/slack>`_!

**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| 2026-03-20 | Product WG | Verawood | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
65 changes: 65 additions & 0 deletions source/developers/concepts/design_tokens.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
.. _Design Tokens:

Design Tokens
#############

What are Design Tokens?
***********************

Design tokens are all the values needed to build and maintain a design system —
spacing, color, typography, object styles, etc. They can represent anything
defined by the design: color as an RGB value, opacity as a number, spacing as a
REM value. They are used instead of hard-coded values to provide flexibility and
uniformity across the application.

By defining style properties as tokens, we can transform the styles into various
implementations compatible with different platforms or formats (e.g.,
transforming tokens to CSS variables, CSS utility classes, and eventually
mobile).

Paragon uses `style-dictionary <https://github.com/style-dictionary/style-dictionary>`_ to build design tokens into CSS variables.

Background & Motivation
***********************

Design tokens debuted as the primary theming mechanism in the Ulmo release (January 2026), and was available for beta testing in the Open edX Teak release (June 2025).

.. warning::

There will be no overlap between the old SCSS-variable theming system and Design Tokens. Site operators must prepare migration strategies in advance.

**Background reading:**

* `Scaling Paragon's styles architecture with design tokens (Confluence) <https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens>`_
* `ADR: design tokens implementation in Paragon <https://github.com/openedx/paragon/blob/master/docs/decisions/0019-scaling-styles-with-design-tokens.rst>`_
* `November 2024 Open edX meetup presentation slides <https://docs.google.com/presentation/d/1FOSbTUTbbzaBoIDYMa5s32in1uFoYWdoQ-GjKk5IRBo/edit?usp=sharing>`_
* `Teak design tokens wiki (includes test branches) <https://openedx.atlassian.net/wiki/spaces/BPL/pages/5050499077/Using+Teak+Design+Tokens+branches>`_

Reference Links
***************

* :ref:`Release note (Ulmo) <Ulmo Design Tokens>`
* `Paragon tokens source (release-23.x) <https://github.com/openedx/paragon/tree/release-23.x/tokens>`_
* `Paragon README: Design Tokens section <https://github.com/openedx/paragon/tree/release-23.x?tab=readme-ov-file#design-tokens>`_
* `brand-openedx (interface definition) <https://github.com/openedx/brand-openedx>`_
* `brand-openedx: design tokens how-to <https://github.com/openedx/brand-openedx/blob/main/docs/how-to/design-tokens-support.rst>`_
* `sample-plugin/brand (purple example) <https://github.com/openedx/sample-plugin/tree/main/brand>`_
* `elm-theme (production example) <https://github.com/edx/elm-theme>`_
* `tutor-contrib-paragon <https://github.com/openedx/openedx-tutor-plugins/tree/main/plugins/tutor-contrib-paragon>`_
* `frontend-platform theming docs <https://github.com/openedx/frontend-platform/blob/master/docs/how_tos/theming.md>`_
* :ref:`OEP-0048: Brand Customization <openedx-proposals:OEP-48 Brand Customization>`
* `style-dictionary docs <https://amzn.github.io/style-dictionary/#/>`_
* `W3C Design Tokens Community Group spec <https://tr.designtokens.org/format/#abstract>`_
* `Confluence: Background/motivation <https://openedx.atlassian.net/wiki/spaces/BPL/pages/3630923811/Scaling+Paragon+s+styles+architecture+with+design+tokens>`_
* `Confluence: Teak test branches <https://openedx.atlassian.net/wiki/spaces/BPL/pages/5050499077/Using+Teak+Design+Tokens+branches>`_
* `Paragon design tokens issues <https://github.com/openedx/paragon/issues?q=design+tokens>`_
* `Paragon CLI issues <https://github.com/openedx/paragon/issues?q=%5BCLI%5D>`_


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| 2026-03-20 | Frontend WG | Verawood | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
2 changes: 1 addition & 1 deletion source/developers/concepts/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Concepts Home
#############

.. toctree::
:maxdepth: 2
:maxdepth: 1
:glob:

*
Expand Down
2 changes: 1 addition & 1 deletion source/developers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Open edX Developers
* :ref:`qs Dev Contributing`
* :ref:`Tutor QS (Dev)`
* :doc:`references/running_pr_tests`
* :doc:`concepts/hooks_extension_framework`
* :doc:`concepts/design_tokens`

.. grid-item-card:: How-tos
:class-card: sd-shadow-md sd-p-2
Expand Down
2 changes: 2 additions & 0 deletions source/site_ops/quickstarts/index.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Site Ops Quickstarts:

Site Operators: Quickstarts
#############################

Expand Down