diff --git a/source/_images/handbook_undraw.png b/source/_images/handbook_undraw.png new file mode 100644 index 000000000..3ec2d4798 Binary files /dev/null and b/source/_images/handbook_undraw.png differ diff --git a/source/_images/trees_undraw.png b/source/_images/trees_undraw.png new file mode 100644 index 000000000..29a3cee31 Binary files /dev/null and b/source/_images/trees_undraw.png differ diff --git a/source/conf.py b/source/conf.py index 0393cbd27..04b844b81 100644 --- a/source/conf.py +++ b/source/conf.py @@ -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 diff --git a/source/documentors/index.rst b/source/documentors/index.rst index 57a2f2bc8..3b1dfbdf7 100644 --- a/source/documentors/index.rst +++ b/source/documentors/index.rst @@ -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 diff --git a/source/handbook/index.rst b/source/handbook/index.rst new file mode 100644 index 000000000..bead10119 --- /dev/null +++ b/source/handbook/index.rst @@ -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 \ No newline at end of file diff --git a/source/index.rst b/source/index.rst index 2b74776e6..af883e356 100644 --- a/source/index.rst +++ b/source/index.rst @@ -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 + Build a Course + Contribute to Open edX Code Base + Update the Documentation + .. toctree:: :maxdepth: 1 - :caption: User Home Pages + :caption: Role Guides :hidden: Community @@ -17,36 +34,15 @@ Open edX Documentation Documentors Translators + +************************** +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 - Site Operators: Set up Open edX - Developers: Contribute to Open edX - Documentors: 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 - All Release Notes - How to Contribute - OEPs (Open edX Proposals): Community Decision Documents - .. grid-item-card:: Educators :class-card: sd-shadow-md sd-p-2 :class-footer: sd-border-0 @@ -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 @@ -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 @@ -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 @@ -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 + All Release Notes + +************************** +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 + Get Help with Open edX + - other/feedback - other/getting_help - Technical Decisions About This Site - developers/references/aspects_home diff --git a/source/links.txt b/source/links.txt index a76de1d29..746cc0d9c 100644 --- a/source/links.txt +++ b/source/links.txt @@ -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 diff --git a/source/other/getting_help.rst b/source/other/getting_help.rst index 3e38f7d52..29492ab74 100644 --- a/source/other/getting_help.rst +++ b/source/other/getting_help.rst @@ -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 `_, please be sure to review it. -.. include:: /links.txt \ No newline at end of file +.. include:: /links.txt + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-08-13 | John (Curricu.me) | Teak | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/site_ops/index.rst b/source/site_ops/index.rst index 3e61c5e97..7e23bfe94 100644 --- a/source/site_ops/index.rst +++ b/source/site_ops/index.rst @@ -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: diff --git a/source/site_ops/install_configure_run_guide/front_matter/getting_help.rst b/source/site_ops/install_configure_run_guide/front_matter/getting_help.rst deleted file mode 100644 index 8e5dff656..000000000 --- a/source/site_ops/install_configure_run_guide/front_matter/getting_help.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. _Getting Help: - -############ -Getting Help -############ - -.. tags:: site operator - -This section describes resources for getting help if you need technical -assistance during the installation process or after your site is running. - - -****************** -Where to Find Help -****************** - -There are a number of places to get help, including mailing lists and real-time -chat. Please choose an appropriate venue for your question. This helps ensure -that you get good prompt advice, and keeps discussion focused. For details of -your options, see the `Getting Help page`_. - - -******************************************* -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. - - -.. _Getting Help page: https://open.edx.org/getting-help -.. _openedx-ops: http://groups.google.com/forum/#!forum/openedx-ops - -.. include:: /links.txt - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/site_ops/install_configure_run_guide/front_matter/index.rst b/source/site_ops/install_configure_run_guide/front_matter/index.rst index 2a2757062..e440e7bc6 100644 --- a/source/site_ops/install_configure_run_guide/front_matter/index.rst +++ b/source/site_ops/install_configure_run_guide/front_matter/index.rst @@ -5,10 +5,10 @@ General Information .. tags:: site operator .. toctree:: - :maxdepth: 2 + :maxdepth: 1 read_me - getting_help + Get Help with Open edX browsers diff --git a/source/translators/index.rst b/source/translators/index.rst index eafe3f12d..819a2df42 100644 --- a/source/translators/index.rst +++ b/source/translators/index.rst @@ -31,6 +31,7 @@ Translators Home :maxdepth: 1 :caption: How-Tos + how-tos/index how-tos/how-to* +++ .. button-ref:: how-tos/index @@ -49,6 +50,7 @@ Translators Home :maxdepth: 1 :caption: Concepts + concepts/index concepts/working* +++ .. button-ref:: concepts/index