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
Binary file added source/_images/handbook_undraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/_images/trees_undraw.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
rediraffe_redirects = {
"community/release_notes/latest.rst": "community/release_notes/index.rst",
"documentors/references/quick_reference_rst.rst": "documentors/references/quick_reference.rst",
"site_ops/install_configure_run_guide/front_matter/getting_help.rst": "other/getting_help.rst",
}

tags_create_tags = True
Expand Down
5 changes: 5 additions & 0 deletions source/documentors/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,11 @@ Open edX Documentors
references/quick_reference.rst


.. toctree::
:maxdepth: 1
:hidden:

decisions/index

.. grid-item-card:: Decisions
:class-card: sd-shadow-md sd-p-2
Expand Down
24 changes: 24 additions & 0 deletions source/handbook/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
Open edX Core Contributors Handbook
###################################

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

.. grid-item-card:: Core Contributors Handbook
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

.. image:: /_images/handbook_undraw.png
:alt: Core Contributor Persona contributing to the platform
:height: 150px
:align: center

Under Construction

.. button-ref:: index
:color: primary
:outline:
:expand:

Core Contributors' Handbook
159 changes: 97 additions & 62 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,26 @@ Open edX Documentation
.. The homepages are provided as links in the panels so we don't need to display
the table of contents for them.

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

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

.. toctree::
:maxdepth: 1
:caption: Quick Starts

Set up Open edX <site_ops/quickstarts/index>
Build a Course <educators/quickstarts/build_a_course>
Contribute to Open edX Code Base <developers/quickstarts/first_openedx_pr>
Update the Documentation <documentors/quickstarts/first_documentation_pr>

.. toctree::
:maxdepth: 1
:caption: User Home Pages
:caption: Role Guides
:hidden:

Community <community/index>
Expand All @@ -17,36 +34,15 @@ Open edX Documentation
Documentors <documentors/index>
Translators <translators/index>


**************************
Role Guides
**************************

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

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

.. toctree::
:maxdepth: 1
:caption: Quick Starts

Educators: Build a Course <educators/quickstarts/build_a_course>
Site Operators: Set up Open edX <site_ops/quickstarts/index>
Developers: Contribute to Open edX <developers/quickstarts/first_openedx_pr>
Documentors: First Documentation PR <documentors/quickstarts/first_documentation_pr>

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

.. toctree::
:maxdepth: 1
:caption: Open Source Community

Current Release: Teak <community/release_notes/teak>
All Release Notes <community/release_notes/index>
How to Contribute <https://openedx.atlassian.net/wiki/spaces/COMM/pages/941457737/How+to+start+contributing+to+the+Open+edX+code+base>
OEPs (Open edX Proposals): Community Decision Documents <https://docs.openedx.org/projects/openedx-proposals/en/latest/>

.. grid-item-card:: Educators
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0
Expand Down Expand Up @@ -96,16 +92,6 @@ Open edX Documentation

Deploy and run an Open edX® site.

.. toctree::
:maxdepth: 1
:hidden:

site_ops/index
site_ops/quickstarts/index
site_ops/concepts/index
site_ops/references/index
site_ops/how-tos/index

+++
.. button-ref:: site_ops/index
:color: primary
Expand All @@ -125,16 +111,6 @@ Open edX Documentation

Enhance and extend the Open edX® Platform.

.. toctree::
:maxdepth: 1
:hidden:

developers/index
developers/quickstarts/index
developers/concepts/index
developers/references/index
developers/how-tos/index

+++
.. button-ref:: developers/index
:color: primary
Expand Down Expand Up @@ -177,16 +153,6 @@ Open edX Documentation

Translate the Open edX® Platform.

.. toctree::
:maxdepth: 1
:hidden:

translators/index
translators/quickstarts/index
translators/concepts/index
translators/references/index
translators/how-tos/index

+++
.. button-ref:: translators/index
:color: primary
Expand All @@ -195,15 +161,84 @@ Open edX Documentation

Translators' Home


.. toctree::
:maxdepth: 1
:caption: Core Contributors Handbook
:hidden:

handbook/index

**************************
Core Contributors Handbook
**************************

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

.. grid-item-card:: Core Contributors Handbook
:class-card: sd-shadow-md sd-p-2
:class-footer: sd-border-0

.. image:: /_images/handbook_undraw.png
:alt: Core Contributor Persona contributing to the platform
:height: 150px
:align: center

A central guide for all current and aspiring Core Contributors to the Open edX project

+++
.. button-ref:: handbook/index
:color: primary
:outline:
:expand:

Core Contributors' Handbook

**************************
Open edX Release Notes
**************************

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

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

.. image:: /_images/trees_undraw.png
:alt: Abstract tree with branches
:height: 150px
:align: center

Release notes for the latest and all previous releases of the Open edX Platform. Our releases are named after trees!

.. toctree::
:maxdepth: 1
:caption: Open edX Release Notes

Current Release: Teak <community/release_notes/teak>
All Release Notes <community/release_notes/index>

**************************
Help & Feedback
**************************

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

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

.. toctree::
:maxdepth: 1
:caption: Other Topics
:caption: Help & Feedback

Provide Feedback on these Docs <other/feedback>
Get Help with Open edX <other/getting_help>


other/feedback
other/getting_help
Technical Decisions About This Site <documentors/decisions/index>
developers/references/aspects_home
2 changes: 2 additions & 0 deletions source/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -339,3 +339,5 @@
.. _retirement: https://user-retirement-guide.readthedocs.io/en/latest/index.html

.. _AWS Documentation: http://aws.amazon.com/documentation/

.. _Getting Help page: https://open.edx.org/getting-help
38 changes: 37 additions & 1 deletion source/other/getting_help.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,45 @@ tasks. If you need help, we recommend posting in the forums over posting in
slack. The forums retain more history and tend to get more thoughtful
responses.

Finally, if you would like to get in touch with Axim and/or our Open edX partners, see the `Getting Help page`_ on the Open edX website. Note that response times here may be slower than the other options.

*******************************************
Information to Provide When Asking for Help
*******************************************

Keep in mind when asking for help that you have much more knowledge of your
situation than others do. You need to provide that context so that people can
understand your problem and provide good help.
To make it easier for others to help you, please provide the following types of
information.

* **What you are trying to do?** What version of the code are you installing,
and why? What is your larger goal?

* **What you have done?** What instructions were you following? What commands
did you run? Did you deviate from the instructions at any point, even a
little bit? Full output of those commands, even if it seems overwhelming,
can be very useful.

* **What has gone wrong?** Are there errors in log files? Did you get specific
failures in the terminal? Provide full details about the undesired results
you saw.

While working through your problem, helpers often need additional information.
Stay involved in the discussion, and try to give them what they need. They know
best what information they need to solve the problem.

.. note::

The Open edX community has agreed upon a shared `code of conduct
<https://openedx.org/code-of-conduct/>`_, please be sure to review it.

.. include:: /links.txt
.. include:: /links.txt

**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| 2025-08-13 | John (Curricu.me) | Teak | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
18 changes: 18 additions & 0 deletions source/site_ops/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,24 @@ Open edX Site Operators
For information about the latest release of the Open edX Platform, you can
check out the :doc:`/community/release_notes/index`

**************************
Quick Links
**************************

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

install_configure_run_guide/index
quickstarts/index
how-tos/index
concepts/index
references/index

*******************************
All Site Operators' Guides
*******************************

.. toctree::
:glob:

Expand Down

This file was deleted.

Loading