Skip to content

Commit 1957e00

Browse files
committed
Add OEX Tutorials community landing page
1 parent 7fe8b68 commit 1957e00

3 files changed

Lines changed: 110 additions & 0 deletions

File tree

source/community/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Community Home
77
release_notes/index
88
concepts/what_is_the_roadmap
99
how-tos/read_the_roadmap
10+
references/tutorials
1011
security_policy/index
1112
how-tos/receive_announcements_by_email
1213
Community Discussion Boards <https://discuss.openedx.org>
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
Open edX Tutorials
2+
##################
3+
4+
Resources for getting started with the Open edX platform are provided here. They
5+
range from “Quickstarts” (step-by-step instructions to getting up and running
6+
with various areas of the Open edX software and community) to hands-on sandboxes
7+
and courses.
8+
9+
Try it Out!
10+
***********
11+
12+
If you've never used the Open edX software, we have a few resources to help you get acquainted:
13+
14+
* `Open edX Sandbox <https://sandbox.openedx.org/>`_ - sign up for a free
15+
account to begin playing around with the Open edX learner and authoring
16+
environments. Once you've registered for an account, access `Open edX Studio
17+
<https://studio.sandbox.openedx.org/>`_ to try your hand at :ref:`authoring courses <Quick Start Build a Course>`
18+
or :ref:`content libraries <Work with Content Libraries>`.
19+
Please be aware that all accounts and content are deleted every 7 days.
20+
21+
* `Open edX Training Site <https://apps.training.openedx.io/catalog/>`_ - this
22+
site provides free courses for those interested in learning more about the
23+
Open edX community and getting started as an Open edX developer. The `Demo
24+
Course
25+
<https://apps.training.openedx.io/catalog/courses/course-v1:OpenedX+DemoX+Demo_Course/about>`_
26+
steps you through various types of Open edX content tools and introduces the
27+
course authoring environment, Studio.
28+
29+
* :ref:`Aspects Data <openedx-aspects:Aspects Home>` -
30+
learn more about Aspects, the Open edX analytics plugin that brings course
31+
teams and site operators actionable data about learner engagement, content
32+
performance, and instance health.
33+
34+
Resources for Specific Roles
35+
****************************
36+
37+
.. grid:: 1 2 2 2
38+
:gutter: 3
39+
:padding: 0
40+
41+
.. grid-item-card:: Content Creators
42+
:class-card: sd-shadow-md sd-p-2
43+
:class-footer: sd-border-0
44+
45+
.. image:: /_images/educators_homepage/educator_undraw.png
46+
:alt: Educator Persona building a course
47+
:height: 150px
48+
:align: center
49+
50+
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.
51+
52+
.. grid-item-card:: Site Operators
53+
:class-card: sd-shadow-md sd-p-2
54+
:class-footer: sd-border-0
55+
56+
.. image:: /_images/site_operators_undraw.png
57+
:alt: Site Operator Persona operating a site
58+
:height: 150px
59+
:align: center
60+
61+
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.
62+
63+
.. grid-item-card:: Extending the Open edX Platform
64+
:class-card: sd-shadow-md sd-p-2
65+
:class-footer: sd-border-0
66+
67+
.. image:: /_images/educators_homepage/olx_undraw.png
68+
:alt: A user with abstract icons around them
69+
:height: 150px
70+
:align: center
71+
72+
The modular Open edX platform provides many extension points that don't require modification to the core codebase. These include:
73+
74+
* :ref:`Frontend plugin "slots" <Use A Frontend Plugin Framework Slot>` for UI customization
75+
* :ref:`XBlocks <xblock:Open edX XBlock Tutorial>`, a composable framework to enable rapid development and pluggability of new content types
76+
* :ref:`Hooks Extension Framework` for modifying the platform's functionality and flows
77+
* Design tokens for theming customization
78+
79+
Check out the `Sample Plugin <https://github.com/openedx/sample-plugin>`_ for documentation and examples of leveraging the various Open edX extension points.
80+
81+
.. grid-item-card:: Developing the Open edX Platform
82+
:class-card: sd-shadow-md sd-p-2
83+
:class-footer: sd-border-0
84+
85+
.. image:: /_images/developers_undraw.png
86+
:alt: Developer Persona enhancing the platform
87+
:height: 150px
88+
:align: center
89+
90+
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.
91+
92+
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.
93+
94+
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.
95+
96+
Questions?
97+
**********
98+
99+
Find the Open edX community on the `Community Discussion Boards <https://discuss.openedx.org>`_ and the `Slack Workspace <https://openedx.org/slack>`_!
100+
101+
**Maintenance chart**
102+
103+
+--------------+-------------------------------+----------------+--------------------------------+
104+
| Review Date | Working Group Reviewer | Release |Test situation |
105+
+--------------+-------------------------------+----------------+--------------------------------+
106+
| 2026-03-20 | Product WG | Verawood | Pass |
107+
+--------------+-------------------------------+----------------+--------------------------------+

source/site_ops/quickstarts/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _Site Ops Quickstarts:
2+
13
Site Operators: Quickstarts
24
#############################
35

0 commit comments

Comments
 (0)