Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
5b5518e
Revert "Update notifications documentation for learners"
saraburns1 Sep 18, 2025
de33e57
chore: Upgrade Python requirements
edx-requirements-bot Sep 21, 2025
83fe5db
docs: add `frontend-lib-special-exams` plugin slots
Agrendalath Sep 24, 2025
7f4c962
build: use ubuntu-lts-latest in readthedocs build
edx-requirements-bot Sep 27, 2025
082593d
chore: Upgrade Python requirements
edx-requirements-bot Sep 28, 2025
bcc25bf
Update Makefile command with suggestion from sphinx-tag project
sarina Sep 17, 2025
f1c7b29
Beautify SiteOps Home and remove duplicate sidebar
sarina Sep 17, 2025
3752c04
Product Marketing release notes for Teak (#1287)
sarina Oct 1, 2025
a7b3950
Update maintainers group with new name
sarina Oct 3, 2025
5532ad4
Update Request a New Language instructions for translators
sarina Sep 18, 2025
ed72a7b
updated currently broken/invalid external links for lists and tables …
Oct 6, 2025
ba7b4c9
Added LTI Store Documentation. (#1288)
usmanpm Oct 7, 2025
4c54809
chore: Upgrade Python requirements
edx-requirements-bot Oct 5, 2025
83c0894
feat: adding documentation for course certificate templates
deborahgu Oct 8, 2025
14dd192
Documentation updated to reflect changes in PR 37331
haftamuk Oct 6, 2025
4eafca2
chore: Upgrade Python requirements
edx-requirements-bot Oct 12, 2025
5712759
chore: Upgrade Python requirements
edx-requirements-bot Oct 19, 2025
ade0dd2
docs: 'how to' view in-context metrics (#1304)
saraburns1 Oct 22, 2025
cb62c51
Update: Anatomy of discussions
ayub02 Oct 24, 2025
aa1d429
Made changes to exploring discussion posts
ayub02 Oct 24, 2025
525331c
Refrence error fixes
ayub02 Oct 24, 2025
d96dbd0
Fixed error related to bullet list
ayub02 Oct 24, 2025
4c37c96
Bullet list fix attempt 2
ayub02 Oct 24, 2025
e42f32a
Explore discussions page improved
ayub02 Oct 27, 2025
c3dc8f0
Fixed some errors
ayub02 Oct 27, 2025
16ced31
Fixed image name reference
ayub02 Oct 27, 2025
5d6c02e
Fixed image file path
ayub02 Oct 27, 2025
52d1b1f
Fixed course nav image
ayub02 Oct 28, 2025
b26b3bb
Fixed discussions page image
ayub02 Oct 28, 2025
dfb2904
Replaced some images as figures
ayub02 Oct 28, 2025
5092689
Added more figures
ayub02 Oct 28, 2025
168333f
Edited add a post page
ayub02 Oct 29, 2025
3a9e5d1
Fixed broken link
ayub02 Oct 29, 2025
27f728a
Fixed broken link
ayub02 Oct 29, 2025
8f2c7c8
Added image of endorsed respons option
ayub02 Oct 29, 2025
accd8a6
Added sections for when post is closed or edited by a moderator
ayub02 Oct 30, 2025
c3de131
Added reported content banner screenshot
ayub02 Oct 30, 2025
5743498
Added screenshot of marked answer indicator
ayub02 Oct 30, 2025
b3858bd
Made improvements with ChatGPT
ayub02 Oct 31, 2025
32597e8
Reorg
ayub02 Nov 3, 2025
61e48f1
Added notifications section
ayub02 Nov 3, 2025
3350ed4
Updating hyperlink in notifications doc
ayub02 Nov 3, 2025
b07497b
Fixed broken table
ayub02 Nov 3, 2025
4611cf3
Fixed headings and other styles
ayub02 Nov 3, 2025
6bf14eb
Added response sort image
ayub02 Nov 5, 2025
68bfea4
Update docs: improved language and screenshots
Nov 11, 2025
4b68aac
Update docs: Fixed reference errors
Nov 11, 2025
720667b
Update source/learners/sfd_discussions/discussions_notifications.rst
ayub02 Dec 3, 2025
070d0a4
Update source/learners/sfd_discussions/take_part_in_discussions.rst
ayub02 Dec 3, 2025
db15684
Update source/learners/sfd_discussions/take_part_in_discussions.rst
ayub02 Dec 3, 2025
c5f668b
Fixes based on Sarina's comments - Part 1
Dec 3, 2025
ed98d81
build: Update review team name
feanil Oct 26, 2025
fa90375
chore: Upgrade Python requirements
edx-requirements-bot Oct 26, 2025
2b2f7ea
docs: Link to the community discussion areas.
feanil Oct 21, 2025
6efdc6c
build: Don't branch or tag this in the named release
kdmccormick Oct 30, 2025
7a75f37
docs: explain lack of release annotation
kdmccormick Oct 31, 2025
b954215
Add note about forums migration to Teak release notes
sarina Oct 30, 2025
549e5aa
Added notifications and preference documentation for educators
ayub02 Sep 18, 2025
92aa082
Fixed hyperlinks
ayub02 Sep 18, 2025
fd94981
Fixed default preferences table
ayub02 Sep 18, 2025
8a3f18f
Upgrade requirements 2025-11-05
sarina Nov 5, 2025
08c3203
Update notifications documentation for learners
ayub02 Sep 17, 2025
267b05d
Add product marketing release notes for Sumac
sarina Nov 3, 2025
7d331cf
Add product marketing release notes for Redwood
sarina Nov 3, 2025
07da2d2
Add product marketing release notes for Quince
sarina Nov 3, 2025
f32587c
Add product marketing release notes for Palm
sarina Nov 3, 2025
59db658
Add product marketing release notes for Olive
sarina Nov 3, 2025
7d465fd
Update Teak marketing notes
sarina Nov 9, 2025
2b63e0d
build: Update Python requirements
sarina Nov 13, 2025
5767e4a
Add how-to for documentors to run locally
sarina Jun 28, 2025
e0acc76
Replace README local dev instructions with docs How-To article
sarina Nov 15, 2025
ce5486b
chore: Upgrade Python requirements
edx-requirements-bot Nov 16, 2025
cbb7e65
Update Entrance Exams page
sarina Nov 17, 2025
529dc22
build: Combine the pip and pip-tools requirment files.
feanil Nov 24, 2025
02be828
chore: Upgrade Python requirements
edx-requirements-bot Nov 30, 2025
3bbd9c2
Add Teak LTI Certification note
sarina Dec 1, 2025
24990ea
Placeholder page for Ulmo catalog and marketing notes
sarina Nov 21, 2025
f3046b5
Add Ulmo LTI certification
sarina Dec 3, 2025
e54635f
Docs: Fixed cross-reference warnings
ayub02 Dec 4, 2025
a3ece12
Docs: Fixes based on Sarina's comments - Part 2
ayub02 Dec 4, 2025
7bf841c
Docs: Fixeed duplicate ref error for notifications
ayub02 Dec 4, 2025
4c31179
Docs: Modified list of default email preferences
ayub02 Dec 11, 2025
2008e7b
WIP on notifications docs update
ayub02 Dec 11, 2025
5a18390
Docs: Modified notification docs for learners with new default prefer…
ayub02 Dec 11, 2025
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
2 changes: 1 addition & 1 deletion .github/workflows/upgrade-python-requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
branch: ${{ github.event.inputs.branch || 'main' }}
# optional parameters below; fill in if you'd like github or email notifications
# user_reviewers: "feanil"
team_reviewers: "docs-openedx-org-maintainers"
team_reviewers: "wg-maintenance-docs.openedx.org"
# email_address: ""
# send_success_notification: false
python_version: "3.12"
Expand Down
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ _tags
source/.DS_Store
.idea/
sphinx-env/
venv/
.venv/
sphinx.log
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sphinx:

# Set the version of python needed to build these docs.
build:
os: "ubuntu-22.04"
os: "ubuntu-lts-latest"
tools:
python: "3.12"
apt_packages:
Expand Down
5 changes: 2 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
pip install -r requirements/pip-tools.txt
# Make sure to compile files after any other files they include!
$(PIP_COMPILE) --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
$(PIP_COMPILE) -o requirements/pip-tools.txt requirements/pip-tools.in
$(PIP_COMPILE) --allow-unsafe -o requirements/pip-tools.txt requirements/pip-tools.in
pip install -r requirements/pip-tools.txt
$(PIP_COMPILE) -o requirements/base.txt requirements/base.in

Expand All @@ -32,7 +31,7 @@ requirements:
pip-sync requirements/base.txt

serve_docs: ## serve the built docs locally to preview the site in the browser
sphinx-autobuild source $(BUILDDIR)/html
sphinx-autobuild source $(BUILDDIR)/html --ignore '**/_tags/*'

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
Expand Down
18 changes: 2 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,11 @@ Build and Test Documentation Locally

For developers comfortable pulling down the repository locally and making changes (see `GitHub Flow`_), you can build the documentation directly on your machine.

To build documentation, inside the root folder, run:

.. code-block:: bash

make clean
make html

Sphinx should build the HTML files locally. To serve the docs locally, run

.. code-block:: bash

make serve_docs

This is a background process, and it will continue updating the docs as you edit them. However if you make substantive changes, you may need to kill the process and run ``make clean``/``make html`` again. We're fortunate to have a lot of docs - but this means that ``make html`` can take 3-4 minutes to run.

You should ensure the documentation builds with no errors or warnings when submitting a pull request.
See the `How-to Develop Documentation Locally`_ guide.

.. _Open edX Documentation: https://docs.openedx.org/
.. _GitHub repository: https://github.com/openedx/docs.openedx.org
.. _RST: https://en.wikipedia.org/wiki/ReStructuredText
.. _Sphinx: https://www.sphinx-doc.org/
.. _GitHub Flow: https://docs.github.com/en/get-started/using-github/github-flow
.. _How-to Develop Documentation Locally: https://docs.openedx.org/en/latest/documentors/how-tos/develop_docs_locally.html
12 changes: 10 additions & 2 deletions catalog-info.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,17 @@ metadata:
title: "Production Site"
icon: "Web"
annotations:
# NAMED RELEASE NOTE:
# This repository gets marked for named releases in a non-standard way!
# Standard repsitories get branch `release/X` on the cut date, and tags `release/X.1`,
# `release/X.2`, and `release/X.3`on the release dates.
# This repo, on the other hand, just gets a `release/X` branch on the X.1 release date.
# This is because a lot of documentation happens between the cut date and the X.1 release date;
# rather than backporting all those docs, we'd rather just make the branch late.
# So, we do not delcare a `openedx.org/release:` key here, because that would confuse the release script.
# Instead, the community Release Manager will manually create the `release/X` branch at the right time.
openedx.org/arch-interest-groups: "feanil"
openedx.org/release: "main"
spec:
owner: group:docs-openedx-org-maintainers
owner: group:wg-maintenance-docs.openedx.org
type: 'website'
lifecycle: 'production'
28 changes: 13 additions & 15 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==1.0.0
# via sphinx
anyio==4.10.0
anyio==4.12.0
# via
# starlette
# watchfiles
babel==2.17.0
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.13.5
beautifulsoup4==4.14.2
# via pydata-sphinx-theme
certifi==2025.8.3
certifi==2025.11.12
# via requests
charset-normalizer==3.4.3
charset-normalizer==3.4.4
# via requests
click==8.2.1
click==8.3.1
# via uvicorn
colorama==0.4.6
# via sphinx-autobuild
Expand All @@ -33,7 +33,7 @@ docutils==0.21.2
# sphinx
h11==0.16.0
# via uvicorn
idna==3.10
idna==3.11
# via
# anyio
# requests
Expand All @@ -47,7 +47,7 @@ markdown-it-py==3.0.0
# via
# mdit-py-plugins
# myst-parser
markupsafe==3.0.2
markupsafe==3.0.3
# via jinja2
mdit-py-plugins==0.5.0
# via myst-parser
Expand All @@ -66,7 +66,7 @@ pygments==2.19.2
# accessible-pygments
# pydata-sphinx-theme
# sphinx
pyyaml==6.0.2
pyyaml==6.0.3
# via
# myst-parser
# sphinxcontrib-mermaid
Expand All @@ -77,8 +77,6 @@ requests==2.32.5
# sphinxcontrib-youtube
roman-numerals-py==3.1.0
# via sphinx
sniffio==1.3.1
# via anyio
snowballstemmer==3.0.1
# via sphinx
soupsieve==2.8
Expand Down Expand Up @@ -124,7 +122,7 @@ sphinxcontrib-images==1.0.1
# via -r requirements/base.in
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-mermaid==1.0.0
sphinxcontrib-mermaid==1.2.3
# via -r requirements/base.in
sphinxcontrib-qthelp==2.0.0
# via sphinx
Expand All @@ -134,9 +132,9 @@ sphinxcontrib-youtube==1.4.1
# via -r requirements/base.in
sphinxemoji==0.3.1
# via -r requirements/base.in
sphinxext-rediraffe==0.2.7
sphinxext-rediraffe==0.3.0
# via -r requirements/base.in
starlette==0.48.0
starlette==0.50.0
# via sphinx-autobuild
typing-extensions==4.15.0
# via
Expand All @@ -146,9 +144,9 @@ typing-extensions==4.15.0
# starlette
urllib3==2.5.0
# via requests
uvicorn==0.35.0
uvicorn==0.38.0
# via sphinx-autobuild
watchfiles==1.1.0
watchfiles==1.1.1
# via sphinx-autobuild
websockets==15.0.1
# via sphinx-autobuild
12 changes: 8 additions & 4 deletions requirements/pip-tools.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
#
build==1.3.0
# via pip-tools
click==8.2.1
click==8.3.1
# via pip-tools
packaging==25.0
# via build
pip-tools==7.5.0
pip-tools==7.5.2
# via -r requirements/pip-tools.in
pyproject-hooks==1.2.0
# via
Expand All @@ -20,5 +20,9 @@ wheel==0.45.1
# via pip-tools

# The following packages are considered to be unsafe in a requirements file:
# pip
# setuptools
pip==25.2
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# pip-tools
setuptools==80.9.0
# via pip-tools
2 changes: 1 addition & 1 deletion requirements/pip.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ wheel==0.45.1
# via -r requirements/pip.in

# The following packages are considered to be unsafe in a requirements file:
pip==25.2
pip==25.3
# via -r requirements/pip.in
setuptools==80.9.0
# via -r requirements/pip.in
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/learners/Discussions_elements.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/learners/Discussions_endorsed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/learners/Discussions_likes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/learners/Discussions_page.png
Binary file added source/_images/learners/Discussions_search.png
Binary file added source/_images/learners/Discussions_sidebar.png
Binary file added source/_images/learners/Discussions_tabs.png
Binary file added source/_images/learners/Discussions_topics.png
Diff not rendered.
Diff not rendered.
Binary file modified source/_images/learners/Notifications_tray_screenshot.png
Diff not rendered.
Binary file removed source/_images/learners/discussion_page.png
Diff not rendered.
2 changes: 2 additions & 0 deletions source/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ Community Home
how-tos/read_the_roadmap
security_policy/index
how-tos/receive_announcements_by_email
Community Discussion Boards <https://discuss.openedx.org>
Slack Workspace <https://openedx.org/slack>
16 changes: 16 additions & 0 deletions source/community/release_notes/olive-landing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,25 @@ These are the release notes for the Palm release, the 16th community release
of the Open edX Platform, released in June 2023. You can also review details
about :doc:`index` or learn more about the `Open edX Platform`_.

.. highlights::

What's new in Olive? Click to read about new features:

:ref:`Olive Product Marketing Notes`

And for more detail on individual products, refer to :ref:`Olive Product Notes`.

.. highlights::

What's new in Olive? Operators and developers, click to read about new
updates, patches, and configuration options.

:doc:`olive`

.. toctree::
:maxdepth: 2

olive/olive_marketing_notes
olive/feature_release_notes
olive

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Olive Product Notes:

Open edX Olive Release - Feature-Based Notes
############################################

Expand Down
6 changes: 6 additions & 0 deletions source/community/release_notes/olive/feature_roundup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ additions to the platform, with brief descriptions of what they are.
:local:
:depth: 1

.. _Olive randomized:

Resets for Randomized Content Blocks
************************************

Expand Down Expand Up @@ -75,6 +77,8 @@ If you want to help out but don't know where to start, visit us on the
`Discussion Forums <http://discuss.openedx.org>`_. Instructions for contributing
are also available `on GitHub <https://github.com/openedx/openedx-test-course#contributing>`_.

.. _Olive pr:

Pages and Resources View
************************

Expand All @@ -93,6 +97,8 @@ that allows you to quickly enable or disable the feature for the course. We'll
cover the various options available when choosing the Discussion option in a
future post.

.. _Olive login:

Authentication Micro-frontend (MFE)
***********************************

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Olive discussions 3party:

Configuring 3rd Party Discussion Experiences (Olive)
####################################################

Expand Down
6 changes: 4 additions & 2 deletions source/community/release_notes/olive/olive_discussions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Olive discussions:

New and Improved Discussions Forum (Olive)
##########################################

Expand Down Expand Up @@ -90,9 +92,9 @@ moderation team, as well as improvements to course authoring. Site operators can
find information about how to configure the new Discussions feature in the Olive
release notes.

*Thank you to `Kshitij Sobti
Thank you to `Kshitij Sobti
<https://opencraft.com/a-look-at-the-recent-enhancements-to-discussions-in-open-edx/>`_
and the team at OpenCraft for the gif shown in this post.*
and the team at OpenCraft for the gif shown in this post.


**Maintenance chart**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Olive discussions moderation:

Moderation & Authoring Tools for the New Discussions Feature (Olive)
####################################################################

Expand Down Expand Up @@ -142,9 +144,9 @@ solutions are not built into the Open edX platform, may cost money, and require
effort from site administrators to enable. See
:doc:`olive_3rd_party_discussions` for more detail.

*Thank you to `Kshitij Sobti
Thank you to `Kshitij Sobti
<https://opencraft.com/a-look-at-the-recent-enhancements-to-discussions-in-open-edx/>`_
and the team at OpenCraft for the gifs shown in this post.*
and the team at OpenCraft for the gifs shown in this post.


**Maintenance chart**
Expand Down
Loading