diff --git a/source/community/how-tos/receive_announcements_by_email.rst b/source/community/how-tos/receive_announcements_by_email.rst deleted file mode 100644 index 81ffc7351..000000000 --- a/source/community/how-tos/receive_announcements_by_email.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. :diataxis-type: how-to - -************************************************* -Receive Open edX Platform Announcements by Email -************************************************* - -The `Open edX Portal`_ is the destination for learning about hosting an Open -edX instance, extending the Open edX platform, and contributing to the Open edX project. In -addition, the Open edX site provides product announcements and other -community resources. - -All users can view content on the Open edX site without creating an account -and logging in. - -To receive and share product and release announcements by email, you can -subscribe to announcements on one of the edX portal sites. - -#. Create an account on the `Open edX Portal`_ as - described above. -#. Select **Community** and then **Announcements**. -#. Under **Subscriptions**, select the different types of announcements that - you want to receive through email. You might need to scroll down to see - these options. -#. Select **Save**. - -You will now receive email messages when new announcements of the types you -selected are posted. - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| 2025-04-01 | Sarina Canelake | Sumac | Pass | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/community/index.rst b/source/community/index.rst index 8c1c4ace8..abd63a355 100644 --- a/source/community/index.rst +++ b/source/community/index.rst @@ -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 Slack Workspace diff --git a/source/community/references/tutorials.rst b/source/community/references/tutorials.rst new file mode 100644 index 000000000..e19a4a489 --- /dev/null +++ b/source/community/references/tutorials.rst @@ -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 `_ - 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 + `_ to try your hand at :ref:`authoring courses ` + or :ref:`content libraries `. + Please be aware that all accounts and content are deleted every 7 days. + +* `Open edX Training Site `_ - 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 + `_ + steps you through various types of Open edX content tools and introduces the + course authoring environment, Studio. + +* :ref:`Aspects Data ` - + 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 ` to build your first Open edX course. Leverage the free-to-use `Studio sandbox `_ 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" ` for UI customization + * :ref:`XBlocks `, 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 ` for theming customization + + Check out the `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 ` 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 ` 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 `_ and the `Developer onboarding course `_ 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 | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/developers/concepts/design_tokens.rst b/source/developers/concepts/design_tokens.rst new file mode 100644 index 000000000..c26b6dfc0 --- /dev/null +++ b/source/developers/concepts/design_tokens.rst @@ -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 `_ 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) `_ +* `ADR: design tokens implementation in Paragon `_ +* `November 2024 Open edX meetup presentation slides `_ +* `Teak design tokens wiki (includes test branches) `_ + +Reference Links +*************** + +* :ref:`Release note (Ulmo) ` +* `Paragon tokens source (release-23.x) `_ +* `Paragon README: Design Tokens section `_ +* `brand-openedx (interface definition) `_ +* `brand-openedx: design tokens how-to `_ +* `sample-plugin/brand (purple example) `_ +* `elm-theme (production example) `_ +* `tutor-contrib-paragon `_ +* `frontend-platform theming docs `_ +* :ref:`OEP-0048: Brand Customization ` +* `style-dictionary docs `_ +* `W3C Design Tokens Community Group spec `_ +* `Confluence: Background/motivation `_ +* `Confluence: Teak test branches `_ +* `Paragon design tokens issues `_ +* `Paragon CLI issues `_ + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2026-03-20 | Frontend WG | Verawood | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/developers/concepts/index.rst b/source/developers/concepts/index.rst index c0a0f6e08..02f0057a8 100644 --- a/source/developers/concepts/index.rst +++ b/source/developers/concepts/index.rst @@ -2,7 +2,7 @@ Concepts Home ############# .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: * diff --git a/source/developers/index.rst b/source/developers/index.rst index 25b41bf09..c15f25330 100644 --- a/source/developers/index.rst +++ b/source/developers/index.rst @@ -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 diff --git a/source/site_ops/quickstarts/index.rst b/source/site_ops/quickstarts/index.rst index 6d47d0fad..7f543568b 100644 --- a/source/site_ops/quickstarts/index.rst +++ b/source/site_ops/quickstarts/index.rst @@ -1,3 +1,5 @@ +.. _Site Ops Quickstarts: + Site Operators: Quickstarts #############################