diff --git a/.github/workflows/upgrade-python-requirements.yml b/.github/workflows/upgrade-python-requirements.yml index 77080046d..9c11c4754 100644 --- a/.github/workflows/upgrade-python-requirements.yml +++ b/.github/workflows/upgrade-python-requirements.yml @@ -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" diff --git a/.gitignore b/.gitignore index a47fbc8b3..e39e1ea11 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ _tags source/.DS_Store .idea/ sphinx-env/ -venv/ +.venv/ +sphinx.log \ No newline at end of file diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 5a71a273f..f63cc9d14 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -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: diff --git a/Makefile b/Makefile index 141641311..c0e10415d 100644 --- a/Makefile +++ b/Makefile @@ -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 @@ -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). diff --git a/README.rst b/README.rst index a6fbdca4f..8661cd809 100644 --- a/README.rst +++ b/README.rst @@ -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 diff --git a/catalog-info.yaml b/catalog-info.yaml index 029249889..af2acb226 100644 --- a/catalog-info.yaml +++ b/catalog-info.yaml @@ -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' diff --git a/requirements/base.txt b/requirements/base.txt index 1c7e51de0..da2d3a7f8 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -8,7 +8,7 @@ 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 @@ -16,13 +16,13 @@ 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 @@ -33,7 +33,7 @@ docutils==0.21.2 # sphinx h11==0.16.0 # via uvicorn -idna==3.10 +idna==3.11 # via # anyio # requests @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt index bfdc0512f..ab00ba416 100644 --- a/requirements/pip-tools.txt +++ b/requirements/pip-tools.txt @@ -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 @@ -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 diff --git a/requirements/pip.txt b/requirements/pip.txt index 42c703428..394969ce1 100644 --- a/requirements/pip.txt +++ b/requirements/pip.txt @@ -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 diff --git a/source/_images/educator_concepts/Notificaitons_grouping_ORA_screenshot.png b/source/_images/educator_concepts/Notificaitons_grouping_ORA_screenshot.png new file mode 100644 index 000000000..7b105d569 Binary files /dev/null and b/source/_images/educator_concepts/Notificaitons_grouping_ORA_screenshot.png differ diff --git a/source/_images/educator_concepts/Notification_daily_email_screenshot.png b/source/_images/educator_concepts/Notification_daily_email_screenshot.png new file mode 100644 index 000000000..47bd8fce8 Binary files /dev/null and b/source/_images/educator_concepts/Notification_daily_email_screenshot.png differ diff --git a/source/_images/educator_concepts/Notifications_tray_forum_screenshot.png b/source/_images/educator_concepts/Notifications_tray_forum_screenshot.png new file mode 100644 index 000000000..66033faba Binary files /dev/null and b/source/_images/educator_concepts/Notifications_tray_forum_screenshot.png differ diff --git a/source/_images/educator_concepts/Notifications_tray_grading_screenshot.png b/source/_images/educator_concepts/Notifications_tray_grading_screenshot.png new file mode 100644 index 000000000..8cd0eed78 Binary files /dev/null and b/source/_images/educator_concepts/Notifications_tray_grading_screenshot.png differ diff --git a/source/_images/educator_concepts/Notifications_tray_screenshot.png b/source/_images/educator_concepts/Notifications_tray_screenshot.png new file mode 100644 index 000000000..5bea22ac6 Binary files /dev/null and b/source/_images/educator_concepts/Notifications_tray_screenshot.png differ diff --git a/source/_images/learners/Notifications_tray_updates_screenshot.png b/source/_images/educator_concepts/Notifications_tray_updates_screenshot.png similarity index 100% rename from source/_images/learners/Notifications_tray_updates_screenshot.png rename to source/_images/educator_concepts/Notifications_tray_updates_screenshot.png diff --git a/source/_images/educator_concepts/Preference_center.png b/source/_images/educator_concepts/Preference_center.png new file mode 100644 index 000000000..cece69ccc Binary files /dev/null and b/source/_images/educator_concepts/Preference_center.png differ diff --git a/source/_images/educator_how_tos/In_Context_Metrics_Graded_Subsection.png b/source/_images/educator_how_tos/In_Context_Metrics_Graded_Subsection.png new file mode 100644 index 000000000..c4d16bb8e Binary files /dev/null and b/source/_images/educator_how_tos/In_Context_Metrics_Graded_Subsection.png differ diff --git a/source/_images/educator_how_tos/add_lti_component.png b/source/_images/educator_how_tos/add_lti_component.png new file mode 100644 index 000000000..2d22af7ca Binary files /dev/null and b/source/_images/educator_how_tos/add_lti_component.png differ diff --git a/source/_images/educator_how_tos/add_lti_store_configuration.png b/source/_images/educator_how_tos/add_lti_store_configuration.png new file mode 100644 index 000000000..157c94630 Binary files /dev/null and b/source/_images/educator_how_tos/add_lti_store_configuration.png differ diff --git a/source/_images/educator_how_tos/create_ltistore_config.png b/source/_images/educator_how_tos/create_ltistore_config.png new file mode 100644 index 000000000..0bf7fa2bb Binary files /dev/null and b/source/_images/educator_how_tos/create_ltistore_config.png differ diff --git a/source/_images/educator_how_tos/edit_lti_component.png b/source/_images/educator_how_tos/edit_lti_component.png new file mode 100644 index 000000000..e9a5e541a Binary files /dev/null and b/source/_images/educator_how_tos/edit_lti_component.png differ diff --git a/source/_images/educator_how_tos/entrance_exam_in_outline.png b/source/_images/educator_how_tos/entrance_exam_in_outline.png new file mode 100644 index 000000000..704cde01d Binary files /dev/null and b/source/_images/educator_how_tos/entrance_exam_in_outline.png differ diff --git a/source/_images/educator_how_tos/entrance_exam_inst_dash.png b/source/_images/educator_how_tos/entrance_exam_inst_dash.png new file mode 100644 index 000000000..5ef2ffa47 Binary files /dev/null and b/source/_images/educator_how_tos/entrance_exam_inst_dash.png differ diff --git a/source/_images/educator_how_tos/require_entrance_exam.png b/source/_images/educator_how_tos/require_entrance_exam.png new file mode 100644 index 000000000..d584b751d Binary files /dev/null and b/source/_images/educator_how_tos/require_entrance_exam.png differ diff --git a/source/_images/learners/Discussions_collapsed_sidebar.png b/source/_images/learners/Discussions_collapsed_sidebar.png new file mode 100644 index 000000000..69a1fa786 Binary files /dev/null and b/source/_images/learners/Discussions_collapsed_sidebar.png differ diff --git a/source/_images/learners/Discussions_course_nav.png b/source/_images/learners/Discussions_course_nav.png new file mode 100644 index 000000000..6aba42112 Binary files /dev/null and b/source/_images/learners/Discussions_course_nav.png differ diff --git a/source/_images/learners/Discussions_creating_post.png b/source/_images/learners/Discussions_creating_post.png new file mode 100644 index 000000000..21dbdcd27 Binary files /dev/null and b/source/_images/learners/Discussions_creating_post.png differ diff --git a/source/_images/learners/Discussions_edit_delete.png b/source/_images/learners/Discussions_edit_delete.png new file mode 100644 index 000000000..c2a8f5f77 Binary files /dev/null and b/source/_images/learners/Discussions_edit_delete.png differ diff --git a/source/_images/learners/Discussions_edited_post_banner.png b/source/_images/learners/Discussions_edited_post_banner.png new file mode 100644 index 000000000..b3fea81bf Binary files /dev/null and b/source/_images/learners/Discussions_edited_post_banner.png differ diff --git a/source/_images/learners/Discussions_elements.png b/source/_images/learners/Discussions_elements.png new file mode 100644 index 000000000..5fac9eb76 Binary files /dev/null and b/source/_images/learners/Discussions_elements.png differ diff --git a/source/_images/learners/Discussions_endorsed.png b/source/_images/learners/Discussions_endorsed.png new file mode 100644 index 000000000..d51db74d8 Binary files /dev/null and b/source/_images/learners/Discussions_endorsed.png differ diff --git a/source/_images/learners/Discussions_filters.png b/source/_images/learners/Discussions_filters.png new file mode 100644 index 000000000..dc770fe42 Binary files /dev/null and b/source/_images/learners/Discussions_filters.png differ diff --git a/source/_images/learners/Discussions_likes.png b/source/_images/learners/Discussions_likes.png new file mode 100644 index 000000000..2d7390e69 Binary files /dev/null and b/source/_images/learners/Discussions_likes.png differ diff --git a/source/_images/learners/Discussions_mark_answer.png b/source/_images/learners/Discussions_mark_answer.png new file mode 100644 index 000000000..387465d5b Binary files /dev/null and b/source/_images/learners/Discussions_mark_answer.png differ diff --git a/source/_images/learners/Discussions_mark_answer_indicator.png b/source/_images/learners/Discussions_mark_answer_indicator.png new file mode 100644 index 000000000..b52f041d9 Binary files /dev/null and b/source/_images/learners/Discussions_mark_answer_indicator.png differ diff --git a/source/_images/learners/Discussions_notification_activity.png b/source/_images/learners/Discussions_notification_activity.png new file mode 100644 index 000000000..6685926dd Binary files /dev/null and b/source/_images/learners/Discussions_notification_activity.png differ diff --git a/source/_images/learners/Discussions_page.png b/source/_images/learners/Discussions_page.png new file mode 100644 index 000000000..1d98af641 Binary files /dev/null and b/source/_images/learners/Discussions_page.png differ diff --git a/source/_images/learners/Discussions_pinned_following.png b/source/_images/learners/Discussions_pinned_following.png new file mode 100644 index 000000000..d2b5e450d Binary files /dev/null and b/source/_images/learners/Discussions_pinned_following.png differ diff --git a/source/_images/learners/Discussions_post_closed_banner.png b/source/_images/learners/Discussions_post_closed_banner.png new file mode 100644 index 000000000..653cf3d98 Binary files /dev/null and b/source/_images/learners/Discussions_post_closed_banner.png differ diff --git a/source/_images/learners/Discussions_report_content.png b/source/_images/learners/Discussions_report_content.png new file mode 100644 index 000000000..a2bef15ab Binary files /dev/null and b/source/_images/learners/Discussions_report_content.png differ diff --git a/source/_images/learners/Discussions_reported_banner.png b/source/_images/learners/Discussions_reported_banner.png new file mode 100644 index 000000000..2efda2291 Binary files /dev/null and b/source/_images/learners/Discussions_reported_banner.png differ diff --git a/source/_images/learners/Discussions_response_comment.png b/source/_images/learners/Discussions_response_comment.png new file mode 100644 index 000000000..3e9878b64 Binary files /dev/null and b/source/_images/learners/Discussions_response_comment.png differ diff --git a/source/_images/learners/Discussions_response_sort.png b/source/_images/learners/Discussions_response_sort.png new file mode 100644 index 000000000..ea8811a94 Binary files /dev/null and b/source/_images/learners/Discussions_response_sort.png differ diff --git a/source/_images/learners/Discussions_search.png b/source/_images/learners/Discussions_search.png new file mode 100644 index 000000000..881c54479 Binary files /dev/null and b/source/_images/learners/Discussions_search.png differ diff --git a/source/_images/learners/Discussions_sidebar.png b/source/_images/learners/Discussions_sidebar.png new file mode 100644 index 000000000..444be1ed5 Binary files /dev/null and b/source/_images/learners/Discussions_sidebar.png differ diff --git a/source/_images/learners/Discussions_tabs.png b/source/_images/learners/Discussions_tabs.png new file mode 100644 index 000000000..c21bc2af8 Binary files /dev/null and b/source/_images/learners/Discussions_tabs.png differ diff --git a/source/_images/learners/Discussions_topics.png b/source/_images/learners/Discussions_topics.png new file mode 100644 index 000000000..ebb032713 Binary files /dev/null and b/source/_images/learners/Discussions_topics.png differ diff --git a/source/_images/learners/Notification_daily_email_screenshot_learner.png b/source/_images/learners/Notification_daily_email_screenshot_learner.png index 455c5bc99..e7a8c70d1 100644 Binary files a/source/_images/learners/Notification_daily_email_screenshot_learner.png and b/source/_images/learners/Notification_daily_email_screenshot_learner.png differ diff --git a/source/_images/learners/Notification_tray_forum_notifications_learner.png b/source/_images/learners/Notification_tray_forum_notifications_learner.png deleted file mode 100644 index 13815d4ee..000000000 Binary files a/source/_images/learners/Notification_tray_forum_notifications_learner.png and /dev/null differ diff --git a/source/_images/learners/Notifications_preference_learner.png b/source/_images/learners/Notifications_preference_learner.png new file mode 100644 index 000000000..e88e81197 Binary files /dev/null and b/source/_images/learners/Notifications_preference_learner.png differ diff --git a/source/_images/learners/Notifications_tray_grading_screenshot_learner.png b/source/_images/learners/Notifications_tray_grading_screenshot_learner.png deleted file mode 100644 index ec1d2df70..000000000 Binary files a/source/_images/learners/Notifications_tray_grading_screenshot_learner.png and /dev/null differ diff --git a/source/_images/learners/Notifications_tray_screenshot.png b/source/_images/learners/Notifications_tray_screenshot.png index 5bea22ac6..b1093dd40 100644 Binary files a/source/_images/learners/Notifications_tray_screenshot.png and b/source/_images/learners/Notifications_tray_screenshot.png differ diff --git a/source/_images/learners/Preference_center_learner.png b/source/_images/learners/Preference_center_learner.png deleted file mode 100644 index f905ab013..000000000 Binary files a/source/_images/learners/Preference_center_learner.png and /dev/null differ diff --git a/source/_images/learners/discussion_page.png b/source/_images/learners/discussion_page.png deleted file mode 100644 index 32b367b62..000000000 Binary files a/source/_images/learners/discussion_page.png and /dev/null differ diff --git a/source/community/index.rst b/source/community/index.rst index af9582605..8c1c4ace8 100644 --- a/source/community/index.rst +++ b/source/community/index.rst @@ -9,3 +9,5 @@ Community Home how-tos/read_the_roadmap security_policy/index how-tos/receive_announcements_by_email + Community Discussion Boards + Slack Workspace diff --git a/source/community/release_notes/olive-landing.rst b/source/community/release_notes/olive-landing.rst index c567af214..f961883ca 100644 --- a/source/community/release_notes/olive-landing.rst +++ b/source/community/release_notes/olive-landing.rst @@ -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 diff --git a/source/community/release_notes/olive/feature_release_notes.rst b/source/community/release_notes/olive/feature_release_notes.rst index fef242e86..6f518e03c 100644 --- a/source/community/release_notes/olive/feature_release_notes.rst +++ b/source/community/release_notes/olive/feature_release_notes.rst @@ -1,3 +1,5 @@ +.. _Olive Product Notes: + Open edX Olive Release - Feature-Based Notes ############################################ diff --git a/source/community/release_notes/olive/feature_roundup.rst b/source/community/release_notes/olive/feature_roundup.rst index 64e2699bb..0657146bf 100644 --- a/source/community/release_notes/olive/feature_roundup.rst +++ b/source/community/release_notes/olive/feature_roundup.rst @@ -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 ************************************ @@ -75,6 +77,8 @@ If you want to help out but don't know where to start, visit us on the `Discussion Forums `_. Instructions for contributing are also available `on GitHub `_. +.. _Olive pr: + Pages and Resources View ************************ @@ -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) *********************************** diff --git a/source/community/release_notes/olive/olive_3rd_party_discussions.rst b/source/community/release_notes/olive/olive_3rd_party_discussions.rst index bdc4add68..6e94394e5 100644 --- a/source/community/release_notes/olive/olive_3rd_party_discussions.rst +++ b/source/community/release_notes/olive/olive_3rd_party_discussions.rst @@ -1,3 +1,5 @@ +.. _Olive discussions 3party: + Configuring 3rd Party Discussion Experiences (Olive) #################################################### diff --git a/source/community/release_notes/olive/olive_discussions.rst b/source/community/release_notes/olive/olive_discussions.rst index 0a20cff13..3118e096b 100644 --- a/source/community/release_notes/olive/olive_discussions.rst +++ b/source/community/release_notes/olive/olive_discussions.rst @@ -1,3 +1,5 @@ +.. _Olive discussions: + New and Improved Discussions Forum (Olive) ########################################## @@ -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 `_ -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** diff --git a/source/community/release_notes/olive/olive_discussions_mods.rst b/source/community/release_notes/olive/olive_discussions_mods.rst index e774fa5bb..7e9f6277d 100644 --- a/source/community/release_notes/olive/olive_discussions_mods.rst +++ b/source/community/release_notes/olive/olive_discussions_mods.rst @@ -1,3 +1,5 @@ +.. _Olive discussions moderation: + Moderation & Authoring Tools for the New Discussions Feature (Olive) #################################################################### @@ -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 `_ -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** diff --git a/source/community/release_notes/olive/olive_marketing_notes.rst b/source/community/release_notes/olive/olive_marketing_notes.rst new file mode 100644 index 000000000..1cb4c36d1 --- /dev/null +++ b/source/community/release_notes/olive/olive_marketing_notes.rst @@ -0,0 +1,84 @@ +.. _Olive Product Marketing Notes: + +Open edX Olive Release (December 2022) +######################################## + +Welcome to the Olive release! This release provides significant improvements and +optimizations for authors and learners. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Enhanced Text Editing in Studio`: +Author text components faster with full-screen editing, visual table creation, +one-click image insertion from your gallery, special characters, emoticons, and +undo/redo - all without touching HTML code. + +:ref:`Powerful Moderation Tools for Discussions `: +With the :ref:`new Discussions experience `, moderators can now +endorse answers, close or edit posts with documented reasons, track learner +activity and reported content, plus enable discussions for any unit with a +single checkbox rather than manual topic configuration. + +:ref:`Integrate Third-Party Discussion Tools `: +Connect your courses with Ed Discussion, Yellowdig, InScribe, or Piazza via +LTI - bringing advanced features like analytics dashboards, graded discussions, +LaTeX support, and collaborative wiki-style answers directly into your learning +experience. + +:ref:`Control Course Features in One Place `: +Turn course tools like Progress pages, Wiki, Calculator, and Discussions on or +off with a single click — no more digging through advanced settings to enable +features your learners need. + + +🎓 For Learners +***************** + +:ref:`Redesigned Discussion Forums `: +Navigate conversations faster with a tabbed interface, mark answers to +questions, search across content and users, like posts inline, and track +activity with interactive post summaries, plus improved moderation tools for +course teams. + +:ref:`Reset Randomized Problem Banks `: +Perfect for flashcard-style study sessions and repeated practice, learners can +now practice exam prep by resetting randomized content blocks to get fresh +questions from a course's problem bank. + +:ref:`User Login Glowup `: Olive provides a +streamlined registration, sign in, and Forgot Password experience. + +🔮 Upcoming in Palm (June 2023) +************************************** + +We're working hard on even more improvements in our :ref:`Palm release (out +now) `! You can look forward to: + +**Redesigned Problem Editor**: Create and edit problems in a full-screen visual +editor without writing Markdown. The new editor features answer options, +scoring, and settings all in one place, plus live previews and easy access to +advanced OLX when you need it. + +**Streamlined ORA Grading**: Grade open response assessments faster with +side-by-side rubrics, file previews (PDFs, images, text), team coordination +features, and batch grading, all in one intuitive interface that lets you review +multiple submissions without switching screens. + +**Issue Verifiable Digital Credentials**: Learners will be able to share +tamper-proof, instantly verifiable program credentials to digital wallets, +giving them portable proof of accomplishments they control and can present to +employers, schools, or anyone they choose in seconds. + +**Schedule Emails to Students**: Instructors will be able to schedule course +emails to send later instead of immediately - perfect for timing announcements, +reminders, and updates when students are most likely to engage. + + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Olive release! + diff --git a/source/community/release_notes/olive/olive_studio_editor.rst b/source/community/release_notes/olive/olive_studio_editor.rst index cf997f922..c3816d57a 100644 --- a/source/community/release_notes/olive/olive_studio_editor.rst +++ b/source/community/release_notes/olive/olive_studio_editor.rst @@ -1,3 +1,5 @@ +.. _Olive editing: + Improved Studio Editing in Olive ################################ diff --git a/source/community/release_notes/palm-landing.rst b/source/community/release_notes/palm-landing.rst index ad6ca0fd1..df78d12d8 100644 --- a/source/community/release_notes/palm-landing.rst +++ b/source/community/release_notes/palm-landing.rst @@ -5,9 +5,26 @@ 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 Palm? Click to read about new features: + + :ref:`Palm Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Palm Product Notes`. + +.. highlights:: + + What's new in Palm? Operators and developers, click to read about new + updates, patches, and configuration options. + + :doc:`palm` + .. toctree:: :maxdepth: 2 + palm/palm_marketing_notes palm/feature_release_notes palm diff --git a/source/community/release_notes/palm/discussions_improvements.rst b/source/community/release_notes/palm/discussions_improvements.rst index fb628514f..5db4491bf 100644 --- a/source/community/release_notes/palm/discussions_improvements.rst +++ b/source/community/release_notes/palm/discussions_improvements.rst @@ -1,3 +1,5 @@ +.. _Palm Discussions: + Improvements to Discussions (Palm) ################################## diff --git a/source/community/release_notes/palm/feature_release_notes.rst b/source/community/release_notes/palm/feature_release_notes.rst index 470085bb3..21532dc6c 100644 --- a/source/community/release_notes/palm/feature_release_notes.rst +++ b/source/community/release_notes/palm/feature_release_notes.rst @@ -1,3 +1,5 @@ +.. _Palm Product Notes: + Open edX Palm Release - Feature-Based Notes ########################################### diff --git a/source/community/release_notes/palm/feature_roundup.rst b/source/community/release_notes/palm/feature_roundup.rst index c48b2c402..3c9267175 100644 --- a/source/community/release_notes/palm/feature_roundup.rst +++ b/source/community/release_notes/palm/feature_roundup.rst @@ -11,6 +11,8 @@ have contributed to this release. :local: :depth: 1 +.. _Palm bulk email: + New Bulk Email Experience ************************* @@ -72,6 +74,8 @@ recent enrollment (default) or title. Courses on the homepage are now *paginated*, meaning only 25 courses will show at one time. This improves the loading time of the page. +.. _DEPR Rate: + Rate XBlock *********** diff --git a/source/community/release_notes/palm/new_problem_editor.rst b/source/community/release_notes/palm/new_problem_editor.rst index 821aeec96..b826f4847 100644 --- a/source/community/release_notes/palm/new_problem_editor.rst +++ b/source/community/release_notes/palm/new_problem_editor.rst @@ -1,3 +1,5 @@ +.. _Palm Editor Improvements: + A New Problem Editor Experience (Palm) ###################################### diff --git a/source/community/release_notes/palm/ora_improvements.rst b/source/community/release_notes/palm/ora_improvements.rst index 658735c83..b5a27cb9a 100644 --- a/source/community/release_notes/palm/ora_improvements.rst +++ b/source/community/release_notes/palm/ora_improvements.rst @@ -1,3 +1,5 @@ +.. _Palm ORA grading: + Enhanced ORA Grading Experience (Palm) ###################################### diff --git a/source/community/release_notes/palm/palm_marketing_notes.rst b/source/community/release_notes/palm/palm_marketing_notes.rst new file mode 100644 index 000000000..2a3dcf7d4 --- /dev/null +++ b/source/community/release_notes/palm/palm_marketing_notes.rst @@ -0,0 +1,81 @@ +.. _Palm Product Marketing Notes: + +Open edX Palm Release (June 2023) +######################################## + +Welcome to the Palm release! Discover new and exciting features for authors, +learners, and site operators. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Redesigned Problem Editor`: +Create and edit problems in a full-screen visual editor without writing +Markdown. The new editor features answer options, scoring, and settings all in +one place, plus live previews and easy access to advanced OLX when you need it. + +:ref:`Streamlined ORA Grading `: +Grade open response assessments faster with side-by-side rubrics, file previews +(PDFs, images, text), team coordination features, and batch grading — all in one +intuitive interface that lets you review multiple submissions without switching +screens. + +:ref:`Issue Verifiable Digital Credentials `: +Learners can now share tamper-proof, instantly verifiable program credentials to +digital wallets, giving them portable proof of accomplishments they control and +can present to employers, schools, or anyone they choose in seconds. + +:ref:`Schedule Emails to Students `: +Instructors can now schedule course emails to send later instead of immediately. +This is perfect for timing announcements, reminders, and updates when students +are most likely to engage. + +🎓 For Learners +***************** + +:ref:`Enhanced Discussions Experience `: +Improved accessibility, faster loading times, and a Discussions "Product Tour" +have been introduced to the Discussions application. + +⚙️ For Site Operators +********************** + +:ref:`The Rate XBlock ` is no longer supported. We recommend using the +`Feedback XBlock `_. + +🔮 Upcoming in Quince (December 2023) +************************************** + +We're working hard on even more improvements in our :ref:`Quince release (out +now) `! You can look forward to: + +**Copy & Paste Course Components**: Reuse text blocks, problems, videos, and +full course units across courses in seconds by copying to a clipboard and +pasting it wherever you need it, cutting down content creation time +dramatically. + +**New DemoX Course**: The new DemoX course will provide five modules that +advance from general to specific knowledge and provide reusable blocks that you +can repurpose for your own courses. + +**Redesigned Learner Home**: Learners will have a sleek, modern hub to view +enrolled courses, filter by status, sort by date or title, and quickly resume +learning. + +**Discussions Right Where You Need Them**: Learners will be able to view, +respond to, and start discussion threads directly within course units via a +collapsible sidebar - no more navigating away from content to join the +conversation. + +**Sell Courses with WooCommerce**: An integration with WooCommerce will let you +create course products, process enrollments, handle refunds, and manage seats +without maintaining your own ecommerce infrastructure. + + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Palm release! + diff --git a/source/community/release_notes/palm/verifiable_credentials.rst b/source/community/release_notes/palm/verifiable_credentials.rst index 41e1484ad..390a03932 100644 --- a/source/community/release_notes/palm/verifiable_credentials.rst +++ b/source/community/release_notes/palm/verifiable_credentials.rst @@ -1,3 +1,5 @@ +.. _Palm credentials: + Verifiable Credentials on the Open edX Platform (Palm) ###################################################### diff --git a/source/community/release_notes/quince-landing.rst b/source/community/release_notes/quince-landing.rst index f52304fd8..4ebf97a9a 100644 --- a/source/community/release_notes/quince-landing.rst +++ b/source/community/release_notes/quince-landing.rst @@ -1,13 +1,30 @@ Open edX Quince Release -####################### +######################### These are the release notes for the Quince release, the 17th community release of the Open edX Platform, released in December 2023. You can also review details about :doc:`index` or learn more about the `Open edX Platform`_. +.. highlights:: + + What's new in Quince? Click to read about new features: + + :ref:`Quince Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Quince Product Notes`. + +.. highlights:: + + What's new in Quince? Operators and developers, click to read about new + updates, patches, and configuration options. + + :doc:`quince` + + .. toctree:: :maxdepth: 2 + quince/quince_marketing_notes quince/feature_release_notes quince diff --git a/source/community/release_notes/quince/copy_paste_b.rst b/source/community/release_notes/quince/copy_paste_b.rst index 09155227d..3059ba5e2 100644 --- a/source/community/release_notes/quince/copy_paste_b.rst +++ b/source/community/release_notes/quince/copy_paste_b.rst @@ -1,3 +1,5 @@ +.. _Copy Paste Quince: + Copy & Paste - Second Phase Release (Quince) ############################################ diff --git a/source/community/release_notes/quince/demox_course.rst b/source/community/release_notes/quince/demox_course.rst index 38ad9e8e4..20175c0d9 100644 --- a/source/community/release_notes/quince/demox_course.rst +++ b/source/community/release_notes/quince/demox_course.rst @@ -1,3 +1,5 @@ +.. _DemoX Quince: + Introducing the New DemoX Course (Quince) ######################################### diff --git a/source/community/release_notes/quince/feature_release_notes.rst b/source/community/release_notes/quince/feature_release_notes.rst index bd3de20b3..f6152977b 100644 --- a/source/community/release_notes/quince/feature_release_notes.rst +++ b/source/community/release_notes/quince/feature_release_notes.rst @@ -1,3 +1,5 @@ +.. _Quince Product Notes: + Open edX Quince Release - Feature-Based Notes ############################################# diff --git a/source/community/release_notes/quince/feature_roundup.rst b/source/community/release_notes/quince/feature_roundup.rst index e19f38e57..cff0549f8 100644 --- a/source/community/release_notes/quince/feature_roundup.rst +++ b/source/community/release_notes/quince/feature_roundup.rst @@ -15,6 +15,8 @@ contributed to this release. See also features previously discussed: For Learners ************ +.. _Learner Home Quince: + New Learner Home ================ @@ -62,6 +64,7 @@ moved to the triple-dot menu at the upper righthand corner of the course cards. .. image:: /_images/release_notes/quince/quince-roundup-4.png +.. _Masquerade Quince: Masquerade Feature for Course Teams ----------------------------------- @@ -74,6 +77,8 @@ in this view. .. image:: /_images/release_notes/quince/quince-roundup-5.png +.. _Discussions Quince: + New In-Context Discussion Sidebar ================================= diff --git a/source/community/release_notes/quince/quince_marketing_notes.rst b/source/community/release_notes/quince/quince_marketing_notes.rst new file mode 100644 index 000000000..c3658ec62 --- /dev/null +++ b/source/community/release_notes/quince/quince_marketing_notes.rst @@ -0,0 +1,83 @@ +.. _Quince Product Marketing Notes: + +Open edX Quince Release (December 2023) +######################################## + +Welcome to the Quince release! Discover new and exciting features for authors, +learners, and site operators. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Copy & Paste Course Components `: +Reuse text blocks, problems, videos, and full course units across courses in +seconds — just copy to clipboard and paste wherever you need it, cutting down +content creation time dramatically. + +:ref:`New DemoX Course `: The new DemoX course is available now. There are +five modules that advance from general to specific knowledge and provide +reusable blocks that you can repurpose for your own courses. + +🎓 For Learners +***************** + +:ref:`Redesigned Learner Home `: +Learners now have a sleek, modern hub to view enrolled courses, filter by +status, sort by date or title, and quickly resume learning. With improved course +cards and easier navigation for large course lists, the new Learner Home is +another step forward in the platform's evolving design vision. + +:ref:`Discussions Right Where You Need Them `: +Learners can now view, respond to, and start discussion threads directly within +course units via a collapsible sidebar - no more navigating away from content to +join the conversation. + +⚙️ For Site Operators +********************** + +:ref:`Sell Courses with WooCommerce Integration `: +The Open edX platform now integrates directly with WooCommerce, letting you +create course products, process enrollments, handle refunds, and manage seats +without maintaining your own ecommerce infrastructure. + +:ref:`See What Learners See `: Via the new Learner Home, +site staff can now view the platform as users on the platform by typing a username or +email in the “View as” box. + + +🔮 Upcoming in Redwood (June 2024) +************************************ + +We're working hard on even more improvements in our :ref:`Redwood release (out +now) `! You can look forward to: + +**Taxonomies and Tags for Easy Organization and Reuse**: Add structured tags +from any third-party taxonomy (or create your own) to courses, units, problems, +and videos — then search by tag to quickly find and reuse content across +courses, align to certifications, or track learning outcomes. + +**Aspects: Analytics Built Right Into Open edX**: Access near real-time +enrollment, engagement, and performance data through interactive dashboards +directly from the Instructor Dashboard. + +**Find Any Content in Seconds with Course Search**: Search across all your +courses (or within one) to instantly locate videos, problems, or text by keyword +or tag. Copy and reuse content in just a few clicks, saving hours of hunting +through course outlines. + +**Studio Glowup**: Studio will debut a sleek, modernized interface, delivering a +consistent, cohesive authoring experience across every page and workflow, built +with authoring efficiency in mind. + +**Share Course Sections Independently**: Hide sections from your course outline +while sharing direct URLs to them, perfect for distributing evergreen resources, +supplemental materials, or reference content that learners need to access +throughout the course. + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Quince release! + diff --git a/source/community/release_notes/quince/woocommerce.rst b/source/community/release_notes/quince/woocommerce.rst index cdcf07cfd..75bbaea39 100644 --- a/source/community/release_notes/quince/woocommerce.rst +++ b/source/community/release_notes/quince/woocommerce.rst @@ -1,3 +1,5 @@ +.. _WooCommerce Quince: + Integrating WooCommerce WordPress Plugin (Quince) ################################################# diff --git a/source/community/release_notes/redwood.rst b/source/community/release_notes/redwood.rst index 5fa53e0c0..6297979b7 100644 --- a/source/community/release_notes/redwood.rst +++ b/source/community/release_notes/redwood.rst @@ -9,7 +9,9 @@ about :doc:`index` or learn more about the `Open edX Platform`_. What's new in Redwood? Click to read about new features: - :doc:`redwood/feature_release_notes`. + :ref:`Redwood Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Redwood Product Notes`. .. highlights:: @@ -22,6 +24,7 @@ about :doc:`index` or learn more about the `Open edX Platform`_. .. toctree:: :maxdepth: 2 + Redwood Overview Redwood Release Notes Redwood Developer & Operator Release Notes diff --git a/source/community/release_notes/redwood/aspects.rst b/source/community/release_notes/redwood/aspects.rst index 937ad6631..ddb21d427 100644 --- a/source/community/release_notes/redwood/aspects.rst +++ b/source/community/release_notes/redwood/aspects.rst @@ -1,3 +1,5 @@ +.. _Aspects Release Notes (Redwood): + Aspects Release Notes (Redwood) ############################### diff --git a/source/community/release_notes/redwood/course_search.rst b/source/community/release_notes/redwood/course_search.rst index 3d2babf43..7c11f4e6f 100644 --- a/source/community/release_notes/redwood/course_search.rst +++ b/source/community/release_notes/redwood/course_search.rst @@ -1,3 +1,5 @@ +.. _Course Search Redwood: + Course Search Beta Release Notes (Redwood) ########################################## diff --git a/source/community/release_notes/redwood/feature_release_notes.rst b/source/community/release_notes/redwood/feature_release_notes.rst index d72666520..34997a348 100644 --- a/source/community/release_notes/redwood/feature_release_notes.rst +++ b/source/community/release_notes/redwood/feature_release_notes.rst @@ -1,3 +1,5 @@ +.. _Redwood Product Notes: + Open edX Redwood Release - Feature-Based Notes ############################################## diff --git a/source/community/release_notes/redwood/potpourri.rst b/source/community/release_notes/redwood/potpourri.rst index 5204b81a9..21b410152 100644 --- a/source/community/release_notes/redwood/potpourri.rst +++ b/source/community/release_notes/redwood/potpourri.rst @@ -8,6 +8,8 @@ of life for both authors and learners. :local: :depth: 1 +.. _Independent Sections (Redwood): + Make Sections available independently of the course outline *********************************************************** diff --git a/source/community/release_notes/redwood/redwood_marketing_notes.rst b/source/community/release_notes/redwood/redwood_marketing_notes.rst new file mode 100644 index 000000000..2bd4790d5 --- /dev/null +++ b/source/community/release_notes/redwood/redwood_marketing_notes.rst @@ -0,0 +1,87 @@ +.. _Redwood Product Marketing Notes: + +Open edX Redwood Release (June 2024) +###################################### + +Welcome to the Redwood release! Discover new and exciting features built +for authors, learners, and site operators. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Taxonomies and Tags for Easy Organization and Reuse `: +Add structured tags from any third-party taxonomy (or create your own) to +courses, units, problems, and videos — then search by tag to quickly find and +reuse content across courses, align to certifications, or track learning +outcomes. + +:ref:`Meet Aspects: Analytics Built Right Into Open edX `: +Access near real-time enrollment, engagement, and performance data through +interactive dashboards directly from the Instructor Dashboard, no separate login +required! With downloadable reports, cross-filtering, and at-risk learner +identification, you'll be able to quickly adapt to the needs of your learners. + +:ref:`Find Any Content in Seconds with Course Search ` +(limited release): Search across all your courses (or within one) to +instantly locate videos, problems, or text by keyword or tag — then copy and reuse +content in just a few clicks, saving hours of hunting through course outlines. + +:ref:`Studio Gets a Complete Makeover `: +Studio now features a sleek, modernized interface, delivering a consistent, +cohesive authoring experience across every page and workflow, built with +authoring efficiency in mind. + +:ref:`Share Course Sections Independently `: +Hide sections from your course outline while sharing direct URLs to them — perfect +for distributing evergreen resources, supplemental materials, or reference +content that learners need to access throughout the course. + +🎓 For Learners +***************** + +:ref:`Navigate Your Way With the New Sidebar Navigation ` +(limited release): Learners can now jump to any unit, section, or subsection +without returning to the Course Outline page — with visual progress indicators and +completion checkmarks that update in real-time as they work through content. + +⚙️ For Site Operators +********************** + +:ref:`Aspects ` is an analytics system for the +Open edX platform, bringing actionable data about course and learner performance +to instructors and site operators. It must be installed separatly from the Open +edX platform, and in future releases will unlock capabilities such as course +comparison dashboards and Studio in-context metrics. + + +🔮 Upcoming in Sumac (December 2024) +************************************ + +We're working hard on even more improvements in our :ref:`Sumac release (out +now) `! You can look forward to: + +**Libraries: Your Content, Reimagined**: Store unlimited content in one Library +instead of juggling dozens, then reuse individual problems, videos, or text +blocks across any course with one-click updates. Create randomized problem +banks, organize with Collections and tags, and sync changes instantly across all +your courses. + +**Compare Courses at a Glance with Aspects**: Spot enrollment trends, gauge problem +difficulty, and compare performance across all your courses or runs in one +dashboard, complete with sortable tables, course tag filters, and quick links to +drill deeper into individual course data. + +**Navigate Your Way: New Sidebar Navigation**: In Sumac, we'll debut a fully +featured, default sidebar navigation experience enabling users to seamlessly +navigate through courses within the courseware experience. + +**Enhanced Mobile App Experience**: Single sign-on, improved translations +experience, a new Course Home experience, and more! + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Redwood release! + diff --git a/source/community/release_notes/redwood/sidebar_nav.rst b/source/community/release_notes/redwood/sidebar_nav.rst index 4af660660..aa66a99e9 100644 --- a/source/community/release_notes/redwood/sidebar_nav.rst +++ b/source/community/release_notes/redwood/sidebar_nav.rst @@ -1,3 +1,5 @@ +.. _Sidebar Navigation Release Notes (Redwood): + Sidebar Navigation Release Notes (Redwood) ########################################## diff --git a/source/community/release_notes/redwood/studio_facelift.rst b/source/community/release_notes/redwood/studio_facelift.rst index 8b4a689ea..ddce0d540 100644 --- a/source/community/release_notes/redwood/studio_facelift.rst +++ b/source/community/release_notes/redwood/studio_facelift.rst @@ -1,3 +1,5 @@ +.. _Studio (Redwood): + Studio Facelift Release Notes (Redwood) ####################################### diff --git a/source/community/release_notes/sumac.rst b/source/community/release_notes/sumac.rst index 827aa3e0f..a67d5cbeb 100755 --- a/source/community/release_notes/sumac.rst +++ b/source/community/release_notes/sumac.rst @@ -9,7 +9,9 @@ about :doc:`index` or learn more about the `Open edX Platform`_. What's new in Sumac? Click to read about new features: - :doc:`sumac/feature_release_notes`. + :ref:`Sumac Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Sumac Product Notes`. .. highlights:: @@ -22,6 +24,7 @@ about :doc:`index` or learn more about the `Open edX Platform`_. .. toctree:: :maxdepth: 2 + Sumac Overview Sumac Release Notes Sumac Developer & Operator Release Notes diff --git a/source/community/release_notes/sumac/aspects_comp_dashboard.rst b/source/community/release_notes/sumac/aspects_comp_dashboard.rst index aa96492fa..6fea60935 100644 --- a/source/community/release_notes/sumac/aspects_comp_dashboard.rst +++ b/source/community/release_notes/sumac/aspects_comp_dashboard.rst @@ -1,3 +1,5 @@ +.. _Aspects Course Comparison Dashboard: + Aspects Course Comparison Dashboard ################################### diff --git a/source/community/release_notes/sumac/customizing_header.rst b/source/community/release_notes/sumac/customizing_header.rst index 8e5a22eb8..a383d3689 100644 --- a/source/community/release_notes/sumac/customizing_header.rst +++ b/source/community/release_notes/sumac/customizing_header.rst @@ -1,3 +1,5 @@ +.. _Frontend Slots Header (Sumac): + Customizing Site Header Using Frontend "Slots" ############################################## @@ -75,9 +77,9 @@ release note! .. seealso:: - * :doc:`/site_ops/how-tos/use-frontend-plugin-slots` + * :ref:`Frontend Slots Learner Dash (Sumac)` - * :doc:`customizing_learner_dashboard` + * :doc:`/site_ops/how-tos/use-frontend-plugin-slots` * :doc:`/site_ops/references/frontend-plugin-slots` diff --git a/source/community/release_notes/sumac/customizing_learner_dashboard.rst b/source/community/release_notes/sumac/customizing_learner_dashboard.rst index 0df17ec02..9ea05b200 100644 --- a/source/community/release_notes/sumac/customizing_learner_dashboard.rst +++ b/source/community/release_notes/sumac/customizing_learner_dashboard.rst @@ -1,3 +1,5 @@ +.. _Frontend Slots Learner Dash (Sumac): + Customizing Learner Dashboard Using Frontend "Slots" #################################################### diff --git a/source/community/release_notes/sumac/default_sidebar_nav.rst b/source/community/release_notes/sumac/default_sidebar_nav.rst index 23d89ae1c..8a76b77e2 100644 --- a/source/community/release_notes/sumac/default_sidebar_nav.rst +++ b/source/community/release_notes/sumac/default_sidebar_nav.rst @@ -1,3 +1,5 @@ +.. _Sidebar Navigation Release Notes (Sumac): + Sidebar Navigation Release Notes (Sumac) ######################################## diff --git a/source/community/release_notes/sumac/dev_op_release_notes.rst b/source/community/release_notes/sumac/dev_op_release_notes.rst index f4ac97cb5..7f2d4d3b1 100644 --- a/source/community/release_notes/sumac/dev_op_release_notes.rst +++ b/source/community/release_notes/sumac/dev_op_release_notes.rst @@ -49,9 +49,9 @@ Administrators & Operators - New Forums Implementation (migration from Ruby to Python forums backend) - - For users running Tutor, they will automatically switch to the new app. Instructions to migrate data from mongodb to mysql is available in the plugin README https://github.com/overhangio/tutor-forum/ (not yet merged, see `feat: upgrade to sumac `_). + - For users running Tutor, they will automatically switch to the new app. Instructions to migrate data from mongodb to mysql is available in the plugin README https://github.com/overhangio/tutor-forum/ - - Users not running Tutor will by default remain on the legacy `cs_comments_service` app. They need to read this part of the forum app README: https://github.com/openedx/forum?tab=readme-ov-file#forum-v2-toggle Some settings need to be defined even for legacy app users. + - Users not running Tutor will by default remain on the legacy ``cs_comments_service`` app. They need to read this part of the forum app README: https://github.com/openedx/forum?tab=readme-ov-file#forum-v2-toggle Some settings need to be defined even for legacy app users. New And Updated Settings and Toggles diff --git a/source/community/release_notes/sumac/feature_release_notes.rst b/source/community/release_notes/sumac/feature_release_notes.rst index c89c29398..d74998ac5 100644 --- a/source/community/release_notes/sumac/feature_release_notes.rst +++ b/source/community/release_notes/sumac/feature_release_notes.rst @@ -1,6 +1,12 @@ +.. _Sumac Product Notes: + Open edX Sumac Release - Product Release Notes ############################################## +The Open edX Teak Release was released on December 9, 2024. + +:ref:`What's New? ` + .. toctree:: :maxdepth: 1 diff --git a/source/community/release_notes/sumac/sumac_marketing_notes.rst b/source/community/release_notes/sumac/sumac_marketing_notes.rst new file mode 100644 index 000000000..32beebe1f --- /dev/null +++ b/source/community/release_notes/sumac/sumac_marketing_notes.rst @@ -0,0 +1,80 @@ +.. _Sumac Product Marketing Notes: + +Open edX Sumac Release (December 2024) +###################################### + +Welcome to the Sumac release! This release provides significant improvements and +optimizations for authors, learners, and site operators. Here's what's ready for you +now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Libraries: Your Content, Reimagined `: +Store unlimited content in one Library instead of juggling dozens, then reuse +individual problems, videos, or text blocks across any course with one-click +updates. Create randomized problem banks, organize with Collections and tags, +and sync changes instantly across all your courses. + +:ref:`Compare Courses at a Glance with Aspects `: +Spot enrollment trends, gauge problem difficulty, and compare performance across +all your courses or runs in one dashboard — complete with sortable tables, course +tag filters, and quick links to drill deeper into individual course data. + +:ref:`LTI Certified ✅ `: The Open edX Sumac Release +has achieved the `LTI Advantage Complete +`_ certification! + +🎓 For Learners +***************** + +:ref:`Navigate Your Way: New Sidebar Navigation `: +Learners can now jump to any unit, section, or subsection without returning to +the Course Outline page — with visual progress indicators and completion +checkmarks that update in real-time as they work through content. + +:ref:`Enhanced Mobile App Experience `: Single sign-on, +improved translations experience, a new Course Home experience, and more! + +⚙️ For Site Operators +********************** + +:ref:`Customize Your Site Header Without Code Forks `: +Site operators can now swap out header elements — like removing the header Help +button — using simple configuration files instead of forking the entire codebase, +making customization faster and easier to maintain. + +🔮 Upcoming in Teak (June 2025) +************************************ + +We're working hard on even more improvements in our :ref:`Teak release (out now) `! +You can look forward to: + +**Easier Content Reuse with Libraries**: Using Libraries, authors will be able +to create modular units that can be reused in multiple courses. Updates and +changes to content can be managed centrally in Libraries, with changes syncing +seamlessly. + +**Aspects Analytics in Studio**: Studio will feature In-Context Analytics, enabling +course teams to make data-driven course improvements without switching tools. + +**More Content Blocks Enabled by Default**: A curated list of high-value content +blocks (e.g., Google Docs, LTI 1.3, Polls, Surveys, Word Cloud) will be enabled +by default in Studio. + +**Give Learners Credentials They'll Want to Share**: Via integrations with +Credly and Accredible, learners will be able to earn digital badges — a more +portable, shareable credential that can be added to social media profiles and +email signatures. + +**More Flexibility To Build Custom Features**: More plugin slots will be added +across the platform to support easier customization and extension by your +development or operations team. + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Sumac release! + diff --git a/source/community/release_notes/teak.rst b/source/community/release_notes/teak.rst index ed152e7da..5b4a72f8e 100755 --- a/source/community/release_notes/teak.rst +++ b/source/community/release_notes/teak.rst @@ -9,12 +9,14 @@ about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ What's new in Teak? Click to read about new features: - :ref:`Teak Product Notes`. + :ref:`Teak Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Teak Product Notes`. .. highlights:: - What's new in Teak? Operators and developers, click to read about new + Operators and developers, click to read about new updates, patches, and configuration options. :ref:`Teak Dev Notes`. @@ -22,6 +24,7 @@ about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ .. toctree:: :maxdepth: 2 + Teak Overview Teak Release Notes Teak Developer & Operator Release Notes diff --git a/source/community/release_notes/teak/dev_op_release_notes.rst b/source/community/release_notes/teak/dev_op_release_notes.rst index d339f7659..5c9909199 100644 --- a/source/community/release_notes/teak/dev_op_release_notes.rst +++ b/source/community/release_notes/teak/dev_op_release_notes.rst @@ -27,6 +27,12 @@ Breaking Changes Administrators & Operators ************************** +- The new Forums implementation (migration from Ruby to Python forums backend) that debuted in Sumac should now be utilized in Teak. The ``cs_comments_service`` app will be removed in the Ulmo release. + + - For users running Tutor, they will automatically switch to the new app. Instructions to migrate data from mongodb to mysql is available in the plugin README https://github.com/overhangio/tutor-forum/ + + - Users not running Tutor will by default remain on the legacy ``cs_comments_service`` app. They need to read this part of the forum app README: https://github.com/openedx/forum?tab=readme-ov-file#forum-v2-toggle Some settings need to be defined even for legacy app users. + Settings and Toggles ==================== diff --git a/source/community/release_notes/teak/feature_release_notes.rst b/source/community/release_notes/teak/feature_release_notes.rst index 76741dea0..24c5c947d 100644 --- a/source/community/release_notes/teak/feature_release_notes.rst +++ b/source/community/release_notes/teak/feature_release_notes.rst @@ -5,6 +5,8 @@ Open edX Teak Release - Product Release Notes The Open edX Teak Release was released on June 9, 2025. +:ref:`What's New? ` + .. toctree:: :maxdepth: 1 @@ -16,6 +18,7 @@ The Open edX Teak Release was released on June 9, 2025. teak_frontend_plugin_slots smaller_changes teak_mobile_updates + teak_lti_cert Information for site operators and developers, including information on how to enable and/or configure new features that require additional work, can be found diff --git a/source/community/release_notes/teak/smaller_changes.rst b/source/community/release_notes/teak/smaller_changes.rst index 2aad21044..afed061e2 100644 --- a/source/community/release_notes/teak/smaller_changes.rst +++ b/source/community/release_notes/teak/smaller_changes.rst @@ -7,6 +7,9 @@ Smaller Changes (Potpourri) :local: :depth: 1 + +.. _Preview Button (Teak): + Preview Button Improvement **************************** @@ -37,6 +40,8 @@ Studio UI Modernization ``legacy_studio.problem_editor``. In Ulmo, this option will be removed: only the new editor will be available. +.. _Problem Editor (Teak): + Problem Editor Improvements **************************** @@ -44,6 +49,7 @@ The new (React-based) editor now supports Markdown by default via course waffle flag. Instance administrators can disable the Markdown editor by creating a flag, ``contentstore.use_react_markdown_editor``, with the value "No". +.. _cc2olx (Teak): Improvements to Common Cartridge Support ***************************************** diff --git a/source/community/release_notes/teak/teak_lti_cert.rst b/source/community/release_notes/teak/teak_lti_cert.rst new file mode 100644 index 000000000..39f49f66c --- /dev/null +++ b/source/community/release_notes/teak/teak_lti_cert.rst @@ -0,0 +1,54 @@ +.. _Teak LTI Certification: + +Teak Release is LTI Advantage Complete Certified +################################################# + +The Open edX Teak Release has achieved the `LTI Advantage Complete +`_ certification. + +Implemented by 1EdTech, the Learning Tools Interoperability (LTI) Advantage set of services improves on +earlier LTI builds to bring a more versatile and secure integration model to the +marketplace. Open edX platform providers and LTI 1.3 compliant partners are able to share +a rich set of data thanks to the LTI Core, Assignment and Grade Services, +Names and Role Services, and Deep Linking specifications outlined by 1EdTech. + +For the platform to get LTI Advantage Certified and listed in the `1EdTech +Product Directory +`_, +it went through a series of situational tests and verified security operations. +A product that completes certification testing for core LTI 1.3 and all three +LTI Advantage services is recognized as LTI Advantage Complete. + +Learn more about LTI Advantage in this video from 1EdTech: + +.. youtube:: SSfhRPMPTX0 + + +View the `1EdTech listing for the Open edX platform here +`_. + +.. seealso:: + + :ref:`About the LTI Component` (concept) + + :ref:`LTI Component Settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Set up an LTI 1_1 component` (how-to) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) + + :ref:`Using Open edX as an LTI Tool Provider` (concept) + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+---------------------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+---------------------------------------------------+ +|2025-12-01 | sarina | Teak | Pass | ++--------------+-------------------------------+----------------+---------------------------------------------------+ + diff --git a/source/community/release_notes/teak/teak_marketing_notes.rst b/source/community/release_notes/teak/teak_marketing_notes.rst new file mode 100644 index 000000000..e93b8b821 --- /dev/null +++ b/source/community/release_notes/teak/teak_marketing_notes.rst @@ -0,0 +1,100 @@ +.. _Teak Product Marketing Notes: + +Open edX Teak Release (June 2025) +################################### + +Welcome to the Teak release! This release puts powerful new tools in your hands +while making everyday tasks simpler. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +:ref:`Easier Content Reuse with Libraries `: Using +Libraries, authors can now create modular units that can be +reused in multiple courses. Updates and changes to content can be managed +centrally in Libraries, with changes syncing seamlessly. Save hours of content +creation by leveraging libraries for reuse in your courses. + +:ref:`Analytics in Studio `: Studio now includes +In-Context Analytics, enabling course teams to make data-driven course improvements without switching tools. With a +new button on Course Outline and Unit pages, authors can view insights like +problem correctness rates and video rewatch patterns without leaving the Studio +page. Spot struggling students early and adjust your teaching approach in real +time. *Note: Requires use of the Aspects analytics system.* + +:ref:`More Content Blocks Enabled by Default `: To reduce +technical barriers and improve discoverability, a curated list of high-value content blocks (e.g., Google Docs, +LTI 1.3, Polls, Surveys, Word Cloud) is now enabled by default in Studio. These +can be accessed via the new “Advanced” tile in the unit editor. + +:ref:`Studio UI Modernization `: Studio now features a +modern, streamlined interface by default on all sites. + +:ref:`Problem Editor Updates `: Write clearer, +more flexible problems with Markdown support in the Problem Editor. + +:ref:`Improved Preview Experience `: The “Preview” +button in Studio now uses the default student experience rather than the legacy experience, letting authors +see content exactly as learners will, improving content validation during +authoring. + +:ref:`LTI Certified ✅ `: The Open edX Teak Release +has achieved the `LTI Advantage Complete +`_ certification! + +🎓 For Learners +***************** + +:ref:`Give Learners Credentials They'll Want to Share `: In +addition to certificates, learners can now earn digital badges — a +more portable, shareable credential that can be added to social media profiles +and email signatures. While certificates provide detailed achievement records, +badges offer quick, visual proof of skills that employers and peers can easily +recognize. Open edX now integrates directly with Accredible and Credly to issue +and manage these badges. + +⚙️ For Site Operators +********************** + +:ref:`More Flexibility To Build Custom Features `: More +plugin slots have been added across the platform to support easier customization and extension by your +development or operations team. + +:ref:`Your Site, Your Brand — Now Faster Than Ever `: Our +new theming system takes only seconds to change, switch, +and deploy your organization's brand themes. Customize your site's look and feel +consistently across your full site. We encourage operators to test out this +system in Teak; it will be required for any theming customization with the Ulmo +upgrade. + +🔮 Upcoming in Ulmo (December 2025) +************************************ + +We're working hard on even more improvements in our Ulmo release! You can look +forward to: + +**Advanced Libraries**: Build entire course sections once, then reuse them +everywhere — imagine updating your intro module across 20 courses with one +click! + +**Smart Notifications**: Never let students miss important discussions again! +Keep learners engaged with timely alerts about new posts and announcements, +delivered both in-platform and via email. + +**Simplified LTI**: Tired of wrestling with LTI integrations? Set up credentials +once and reuse them across all your tools with our streamlined LTI 1.3 plugin. + +**Beautiful Course Pages**: Your course catalog is getting a major glow-up! New, +customizable pages will help you showcase courses with modern design and full +theming support. + +**Important**: The Ulmo release will require the new theming system. Get ahead +of the curve and test it now so your upgrade is seamless! + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Teak release! + diff --git a/source/community/release_notes/ulmo.rst b/source/community/release_notes/ulmo.rst index b80f8488e..b6e4ede09 100755 --- a/source/community/release_notes/ulmo.rst +++ b/source/community/release_notes/ulmo.rst @@ -9,7 +9,9 @@ about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ What's new in Ulmo? Click to read about new features: - :ref:`Ulmo Product Notes`. + :ref:`Ulmo Product Marketing Notes` + + And for more detail on individual products, refer to :ref:`Ulmo Product Notes`. .. highlights:: @@ -22,6 +24,7 @@ about :ref:`Open edX Release Notes` or learn more about the `Open edX Platform`_ .. toctree:: :maxdepth: 2 + Ulmo Overview Ulmo Release Notes Ulmo Developer & Operator Release Notes diff --git a/source/community/release_notes/ulmo/feature_release_notes.rst b/source/community/release_notes/ulmo/feature_release_notes.rst index 774929fdf..e2881dfbe 100644 --- a/source/community/release_notes/ulmo/feature_release_notes.rst +++ b/source/community/release_notes/ulmo/feature_release_notes.rst @@ -5,12 +5,16 @@ Open edX Ulmo Release - Product Release Notes *Releasing December, 2025!* +:ref:`What's New? ` + .. toctree:: :maxdepth: 1 ulmo_mobile_updates + ulmo_catalog design_tokens stay_up_to_date + ulmo_lti_cert Information for site operators and developers, including information on how to diff --git a/source/community/release_notes/ulmo/ulmo_catalog.rst b/source/community/release_notes/ulmo/ulmo_catalog.rst new file mode 100644 index 000000000..25891f059 --- /dev/null +++ b/source/community/release_notes/ulmo/ulmo_catalog.rst @@ -0,0 +1,26 @@ +.. _Ulmo catalog: + +Course Catalog Revamp +###################### + +In the Ulmo release, a new and improved Course Catalog is available. This new +catalog experience features an updated UI, better searching and sorting, and +highly customizable Catalog and Course About pages. + +Visual Improvements +******************** + +(insert screenshots) + +Customizability +***************** + +(link to available plugin slots) + +Ready To Try It Out? +********************** + +Site operators should see *these (link)* instructions to install the new Course +Catalog on their Ulmo instance. + +Note: The new experience will be on-by-default starting in the Verawood release. \ No newline at end of file diff --git a/source/community/release_notes/ulmo/ulmo_lti_cert.rst b/source/community/release_notes/ulmo/ulmo_lti_cert.rst new file mode 100644 index 000000000..ae1c6a2ed --- /dev/null +++ b/source/community/release_notes/ulmo/ulmo_lti_cert.rst @@ -0,0 +1,54 @@ +.. _Ulmo LTI Certification: + +Ulmo Release is LTI Advantage Complete Certified +################################################# + +The Open edX Ulmo Release has achieved the `LTI Advantage Complete +`_ certification. + +Implemented by 1EdTech, the Learning Tools Interoperability (LTI) Advantage set of services improves on +earlier LTI builds to bring a more versatile and secure integration model to the +marketplace. Open edX platform providers and LTI 1.3 compliant partners are able to share +a rich set of data thanks to the LTI Core, Assignment and Grade Services, +Names and Role Services, and Deep Linking specifications outlined by 1EdTech. + +For the platform to get LTI Advantage Certified and listed in the `1EdTech +Product Directory +`_, +it went through a series of situational tests and verified security operations. +A product that completes certification testing for core LTI 1.3 and all three +LTI Advantage services is recognized as LTI Advantage Complete. + +Learn more about LTI Advantage in this video from 1EdTech: + +.. youtube:: SSfhRPMPTX0 + + +View the `1EdTech listing for the Open edX platform here +`_. + +.. seealso:: + + :ref:`About the LTI Component` (concept) + + :ref:`LTI Component Settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Set up an LTI 1_1 component` (how-to) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) + + :ref:`Using Open edX as an LTI Tool Provider` (concept) + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+---------------------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+---------------------------------------------------+ +|2025-12-01 | sarina | Ulmo | Pass | ++--------------+-------------------------------+----------------+---------------------------------------------------+ + diff --git a/source/community/release_notes/ulmo/ulmo_marketing_notes.rst b/source/community/release_notes/ulmo/ulmo_marketing_notes.rst new file mode 100644 index 000000000..5f0e5e813 --- /dev/null +++ b/source/community/release_notes/ulmo/ulmo_marketing_notes.rst @@ -0,0 +1,59 @@ +.. _Ulmo Product Marketing Notes: + +Open edX Ulmo Release (December 2025) +###################################### + +Welcome to the Ulmo release! Discover new and exciting features built +for authors, learners, and site operators. Here's what's ready for you now: + +🧑‍🏫 For Course Authors +******************************** + +**Advanced Libraries**: Build entire course sections once, then reuse them +everywhere — imagine updating your intro module across 20 courses with one +click! + +**Simplified LTI**: Tired of wrestling with LTI integrations? Set up credentials +once and reuse them across all your tools with our streamlined LTI 1.3 plugin. + +:ref:`LTI Certified ✅ `: The Open edX Ulmo Release +has achieved the `LTI Advantage Complete +`_ certification! + +🎓 For Learners +***************** + +:ref:`Beautiful Course Pages `: Your course catalog is getting a +major glow-up! New, customizable pages help you showcase courses with modern +design and full theming support. + +**Smart Notifications**: Never let students miss important discussions again! +Keep learners engaged with timely alerts about new posts and announcements, +delivered both in-platform and via email. + +⚙️ For Site Operators +********************** + +**Important**: The Ulmo release will require the new theming system. Get ahead +of the curve and test it now so your upgrade is seamless! + +🔮 Upcoming in Verawood (June 2026) +************************************ + +We're working hard on even more improvements in our Verawood release! You can look +forward to: + +**Instructor Dashboad Overhaul**: A beautiful, themeable Instructor Dashboard +with numerous usability improvements is coming your way. + +**LTI Overhaul**: Even more LTI improvements to make course authoring and +LTI component reuse a breeze! + + +⌚ Ready to Upgrade? +*********************** + +Have your site operations team check out the `Tutor upgrading guide +`_ so they can upgrade your +Open edX instance to the Ulmo release! + diff --git a/source/developers/concepts/oep58.rst b/source/developers/concepts/oep58.rst index 827d90745..501c4b62c 100644 --- a/source/developers/concepts/oep58.rst +++ b/source/developers/concepts/oep58.rst @@ -1,3 +1,5 @@ +.. _OEP-58 Overview: + OEP-58 Overview ############### diff --git a/source/documentors/how-tos/add_a_doc_via_github.rst b/source/documentors/how-tos/add_a_doc_via_github.rst index 5a0e9f224..4fd2a7011 100644 --- a/source/documentors/how-tos/add_a_doc_via_github.rst +++ b/source/documentors/how-tos/add_a_doc_via_github.rst @@ -108,6 +108,8 @@ With your new branch active: :ref:`Documentation Audiences` (concept) + :ref:`FAQ PR Process` (reference) + **Maintenance chart** diff --git a/source/documentors/how-tos/develop_docs_locally.rst b/source/documentors/how-tos/develop_docs_locally.rst new file mode 100644 index 000000000..bff537b88 --- /dev/null +++ b/source/documentors/how-tos/develop_docs_locally.rst @@ -0,0 +1,142 @@ +.. _Develop Docs Locally: + +Develop Docs Locally +######################## + +.. tags:: documentor, how-to + + +If you are familiar with the basics of a local development environment, you can +set one up to develop documentation locally - that is, on your machine rather +than waiting for the automated build on GitHub. + +Prerequisites +************** + +In this How-To guide, we assume that you have the following: + +* A Mac or Linux environment +* Familiarity with the command line (terminal application), or the desire to learn! + +Set Up Your Environment +************************* + +#. On a Mac, first install `homebrew `_ using the command line ("Terminal" application on a Mac):: + + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + +#. Install Python, using the version specified in `.readthedocs.yaml `_:: + + # On Mac + brew install python3.12 # Insert proper version here + +#. Install Git:: + + # On Mac + brew install git + +#. Create a directory to hold your openedx code (I call it ``openedx`` but you + can call it anything) and switch to that directory:: + + mkdir openedx + cd openedx + +#. Using the command line, clone the repo locally, into a directory you use to + write Open edX code (for example, a directory called ``openedx``):: + + git clone git@github.com:openedx/docs.openedx.org.git + +#. Switch into the ``docs.openedx.org`` folder:: + + cd docs.openedx.org + +#. Create a new `Virtualenv + `_ + for docs development:: + + python3.12 -m venv .venv # Use proper Python version here + +#. Activate the virtual environment:: + + source .venv/bin/activate + +Writing Documentation Locally +****************************** + +#. Set up a local code editor. `VS code (download link) + `_ is recommended as it is easy to + use. + +#. Set up your code editor to read from your ``openedx`` folder. + +#. Write some docs!! + +Build and Test Documentation Locally +************************************ + +#. First, ensure you are working within your docs virtual environment, and run the requirements script:: + + cd openedx # or the folder where you cloned the docs.openedx.org repo + cd docs.openedx.org + source .venv/bin/activate + make requirements + + +#. To build documentation inside the root folder, run:: + + make clean + make html + +#. Sphinx should build the HTML files locally. If there are errors, you will + need to address them. Once the HTML successfully builds ("The HTML pages are + in build/html."), To serve the docs locally, run:: + + make serve_docs + +Once this process is running, you can view the docs in your browser by +navigating to http://127.0.0.1:8000 + +.. note:: + This is a background process, and it will continue updating the docs as + you edit them. However if you make substantive changes, such as adding + cross-references, intersphinx references, or lines to ``links.txt``, you should + 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. Occasionally the docs build on the pull request will +contain errors that weren't caught locally, so do check the upstream build +before requesting reviews. If you're stumped by an error, please tag the docs +maintainer team on your pull request and ask for help! + +Making a Pull Request +********************** + +Follow the :ref:`Process for Contributing Code`. + +The `gh CLI tool `_ is a great way to interact with +GitHub on the command line. You can also interact with GitHub via your code +editor (for example, `Using Git with VS Code +`_). + + +.. seealso:: + + :ref:`About Open edX Documentation Standards` (concept) + + :ref:`Add New Documentation via GitHub` (how-to) + + :ref:`Update an Existing Doc via GitHub` (how-to) + + :ref:`Make Changes to your Pull Request` (how-to) + + :ref:`FAQ PR Process` (reference) + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-11-15 | sarina | Ulmo | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/documentors/how-tos/update_a_doc_via_github.rst b/source/documentors/how-tos/update_a_doc_via_github.rst index 6488926ed..161926604 100644 --- a/source/documentors/how-tos/update_a_doc_via_github.rst +++ b/source/documentors/how-tos/update_a_doc_via_github.rst @@ -81,6 +81,9 @@ The Open edX team will then review your changes. If they approve, they will merg :ref:`Documentation Audiences` (concept) + :ref:`FAQ PR Process` (reference) + + **Maintenance chart** +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/documentors/index.rst b/source/documentors/index.rst index 3b1dfbdf7..96b3e274c 100644 --- a/source/documentors/index.rst +++ b/source/documentors/index.rst @@ -72,6 +72,7 @@ Open edX Documentors references/doc_style_guide.rst references/doc_templates.rst references/quick_reference.rst + how-tos/develop_docs_locally.rst .. grid-item-card:: Add a New Document :class-card: sd-shadow-md sd-p-2 diff --git a/source/documentors/quickstarts/first_documentation_pr.rst b/source/documentors/quickstarts/first_documentation_pr.rst index a0b59fcbd..32c40de4d 100644 --- a/source/documentors/quickstarts/first_documentation_pr.rst +++ b/source/documentors/quickstarts/first_documentation_pr.rst @@ -109,8 +109,9 @@ you want to take a look at your work. As you can see, both the "Note" box and the part that starts with ``:ref:``, which display correctly on docs.openedx.org, do not render correctly in the GitHub preview. - Solutions to this problem are to install a local development environment (How-To - article TBD), or rely on the "pull request build", discussed below. + Solutions to this problem are to :ref:`install a local development + environment `, or rely on the "pull request build", + discussed below. Save your changes diff --git a/source/documentors/references/quick_reference.rst b/source/documentors/references/quick_reference.rst index 25c47f8db..3e59c4082 100644 --- a/source/documentors/references/quick_reference.rst +++ b/source/documentors/references/quick_reference.rst @@ -265,7 +265,7 @@ Both examples above produce the following published list: * Item 2 -See the `RST guide on lists `_ for more detail. +See the `RST guide on lists `_ for more detail. Linking ******* @@ -507,7 +507,7 @@ Use the following code: | Last-Modified | 2024-11-08 | | Documents | - Open edX Documentors Style Guide
- Open edX Diataxis Criteria
- Example 3
- Example 4
- Example 5 | -.. seealso:: To see alternative ways of defining tables, visit the `RST documentation about this topic `_. +.. seealso:: To see alternative ways of defining tables, visit the `RST documentation about this topic `_. Add a Substitution ****************** diff --git a/source/documentors/references/templates/doc_concept_template.rst b/source/documentors/references/templates/doc_concept_template.rst index 438be3799..648e25f92 100644 --- a/source/documentors/references/templates/doc_concept_template.rst +++ b/source/documentors/references/templates/doc_concept_template.rst @@ -3,7 +3,7 @@ Concept Document Template ######################### -.. tags:: documentor, reference +.. tags:: documentor, concept A concept is a document that clarifies and illuminates a particular topic. It is understanding-oriented. It could be considered a conceptual guide. This type of document answers a why question. It could be descriptive, historical, or even propose different alternatives to explain the bigger picture and give context. diff --git a/source/documentors/references/templates/doc_how_to_template.rst b/source/documentors/references/templates/doc_how_to_template.rst index 54431ef60..12e1ff4d3 100644 --- a/source/documentors/references/templates/doc_how_to_template.rst +++ b/source/documentors/references/templates/doc_how_to_template.rst @@ -3,7 +3,7 @@ How-To Document Template ######################## -.. tags:: documentor, reference +.. tags:: documentor, how-to A How-To guide document guides the reader through the steps to solve a real-world problem. This documentation is goal-oriented and similar to recipes, with directions that guide the reader through the steps to achieve a specific end. diff --git a/source/documentors/references/templates/doc_quickstart_template.rst b/source/documentors/references/templates/doc_quickstart_template.rst index 3d72c368f..8b73ee793 100644 --- a/source/documentors/references/templates/doc_quickstart_template.rst +++ b/source/documentors/references/templates/doc_quickstart_template.rst @@ -3,7 +3,7 @@ Quickstart Document Template ############################ -.. tags:: documentor, reference +.. tags:: documentor, quickstart What Is a Quickstart ******************** diff --git a/source/educators/concepts/communication/notifications_preferences.rst b/source/educators/concepts/communication/notifications_preferences.rst new file mode 100644 index 000000000..86894e2dd --- /dev/null +++ b/source/educators/concepts/communication/notifications_preferences.rst @@ -0,0 +1,194 @@ +.. _Notifications & Preferences Educators: + +########################### +Notifications & Preferences +########################### + +.. tags:: educator, concept + +.. contents:: + :local: + :depth: 1 + +Notifications keep you informed about activity in your courses. + +.. _Notification Types: + +Notification Types +################## + +Discussions Notifications +************************* + +#. Activity notifications: New responses or comments on your posts and the ones you are following, and endorsements to your responses and the ones on your post. +#. New discussion posts: When a new discussion post is created. +#. New question posts: When a new question post is created. +#. Reported content: When content is reported. + + #. This notification is only sent to users having a forum moderator role (discussion admin, discussion moderator, community TA and group community TA). + +#. New posts from instructors: When the instructor creates a post and chooses to notify the learners. + + +.. image:: /_images/educator_concepts/Notifications_tray_forum_screenshot.png + :width: 400 + :align: center + :alt: Clicking the bell on the top right opens the notifications tray. + +Updates +******** + +#. Course updates: When the instructor creates a new course update. + +.. image:: /_images/educator_concepts/Notifications_tray_updates_screenshot.png + :width: 400 + :align: center + :alt: Screenshot of a course update notification in tray. + +Grading +******** + +#. ORA grade received: When your submission for an open response assessment (ORA) receives a grade. +#. ORA new submissions: When a learner submits an ORA that requires staff grading. + + #. This notification is only sent to users having a course staff or course admin role. + +.. image:: /_images/educator_concepts/Notifications_tray_grading_screenshot.png + :width: 400 + :align: center + :alt: Screenshot of all grading notifications in tray. + + +.. _Delivery Channels: + +Delivery Channels +################# + +Tray +**** + +- The intent of notification tray is to keep users informed while they're on the web platform. +- A bell icon in the top-right corner displays the count of unread notifications. +- When clicked, it opens a tray that organizes notifications into tabs based on platform area (Discussions, Grading, Updates). +- Each notification includes the relevant course's name, a red dot to indicate it's unread (not clicked), and a timestamp showing when it was generated. +- A gear icon in the tray's top-right corner links to the preferences center, where users can adjust their notification settings. + +.. image:: /_images/educator_concepts/Notifications_tray_screenshot.png + :width: 700 + :align: center + :alt: Clicking the bell on the top right opens the notifications tray. + +Email Notifications +******************* + +- The intent of notification email is to keep users informed even when they're away from the platform. +- Users can choose to get notified immediately or to receive a daily or weekly summary of notifications. + + - Immediately: Receive the email notification as soon as the activity happens. + - Daily: Receive a summary of notifications for the past 24 hours, everyday at 2200hrs UTC. + - Weekly: Receive a summary of notifications for the past 7 days, everyday Saturday at 2200hrs UTC. + +- Emails have a one-click unsubscribe option which allows turning off email notifications for all activity types. + +.. image:: /_images/educator_concepts/Notification_daily_email_screenshot.png + :width: 400 + :align: center + :alt: Screenshot of email having daily summary of notifications. + +.. _Managing Preferences: + +Managing Preferences +#################### + +Preferences center allows users to control which notifications they receive, how often, and through which channel. Users can get to the preferences page via: + +- “Notifications” tab on the “Account Settings” page. +- Gear icon in top right corner in the notification tray. +- “Notification Settings” link in email. + +For each preference: + +- Users can toggle tray and email preference ON or OFF. +- Users can set cadence for email notifications: Immediately, Daily and Weekly. + +.. image:: /_images/educator_concepts/Preference_center.png + :width: 700 + :align: center + :alt: Screenshot of preference center on Account Settings. + + +Default Settings +***************** + +- High-value notifications have tray and email ON by default. + + - “New posts from instructors” and “Course updates” are exceptions where email is OFF by default to prevent high volume/cost of email due to courses with large enrollments. + +- High-volume notifications (e.g., new discussion posts) are OFF by default to prevent clutter. +- Email cadence default is set to “Daily” for all preferences where email default ON. + +The table below shows defaults for each notification type. + +.. list-table:: + :widths: 25 25 25 25 + :align: center + :header-rows: 1 + + * - Preference + - Default Tray Preference + - Default Email Preference + - Visibility + * - Activity notifications + - ON + - ON / Daily + - All + * - New discussion posts + - OFF + - OFF + - All + * - New question qosts + - OFF + - OFF + - All + * - New posts from instructors + - ON + - ON + - All + * - Reported content + - ON + - ON / Daily + - Forum moderators + * - Course updates + - ON + - OFF + - All + * - Essay assignment grade received + - ON + - ON / Daily + - All + * - New ORA submission for staff grading + - ON + - OFF + - Course staff, Course admin + +.. _Notifications Grouping: + +Notifications Grouping +###################### + +High-volume notifications, such as new discussion posts or new ORA submissions, can clutter the notification tray. This clutter reduces the visibility of other important notifications, making it challenging for users to stay informed effectively. As a result, crucial but potentially high-volume notifications need to be turned off by default to avoid overwhelming users. The notification grouping feature mitigates this issue by combining similar notifications into a single, unified notification, based on their context. Currently, grouping is supported for two notification types: + +- New discussion posts: Notifications are grouped by the specific course. +- New ORA submissions: Notifications are grouped by the ORA assignment ID. + +.. image:: /_images/educator_concepts/Notificaitons_grouping_ORA_screenshot.png + :width: 400 + :align: center + :alt: Screenshot of grouped and ungrouped ORA submission received notification. + +.. _Notifications Expiry: + +Notifications Expiry +###################### + +Everyday, notifications older than 60 days are deleted from the database to keep the storage in control. Developers can change this duration from the django settings page. diff --git a/source/educators/how-tos/course_development/exercise_tools/setup_lti_reusable_consumer.rst b/source/educators/how-tos/course_development/exercise_tools/setup_lti_reusable_consumer.rst new file mode 100644 index 000000000..86984e433 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/setup_lti_reusable_consumer.rst @@ -0,0 +1,85 @@ +.. _Set up an LTI Consumer with Reusable LTI Configuration: + + +Set up an LTI Consumer with Reusable LTI Configuration +###################################################### + +.. tags:: educator, how-to + + +Overview +******** + +Reusable LTI configurations are created once by an administrator in Django Admin (LTI Store) and identified by a filter key. +In Studio, you can point an LTI Consumer component to that reusable configuration, avoiding repeated copy/paste of credentials. + + +Before you start +**************** + +* An administrator has created a reusable LTI 1.3 configuration in Django Admin. +* You have the reusable configuration’s filter key. It may be shared as a value like ``lti_store:reference_tool`` +* You have edit access to the course in Studio. + +.. note:: + The following steps correspond to an **LTI 1.3 configuration**. + + +Add the LTI Consumer component +****************************** + +#. Open your course in Studio. +#. Navigate to the unit where you want to add the tool. +#. Add Component → Advanced → LTI Consumer. + +.. image:: /_images/educator_how_tos/add_lti_component.png + :alt: 'Add advanced component' dialog box displaying the LTI component as selected + +Configure the LTI Consumer to use the reusable configuration +************************************************************ + +#. Open the component’s settings (Edit). +#. Set **Configuration type** to *Reusable configuration*. +#. Set **LTI version** to *LTI 1.3*. +#. Set **Reusable configuration ID**: + + * Enter the filter key for the reusable configuration, typically the slug value prefixed as shown in your instance (for example, ``lti_store:reference_tool``). + +#. (Optional) Update the **Display name** and any course-facing settings as needed. +#. Save. + +.. image:: /_images/educator_how_tos/edit_lti_component.png + :alt: LTI component in editing mode, displaying the fields to be edited + +Publish and test +**************** + +* Publish the unit. +* In the LMS, open the unit and launch the LTI tool to verify it loads as expected. + + +What changes compared to on-block configuration +*********************************************** + +* No tool credentials are entered on the block. +* Updates to the centralized configuration in Django Admin apply to all blocks that reference it. + + +.. seealso:: + + :ref:`Set up a Reusable LTI Store` (how-to) + + :ref:`LTI Component Settings` (reference) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| | | Ulmo | Draft | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/setup_lti_store.rst b/source/educators/how-tos/course_development/exercise_tools/setup_lti_store.rst new file mode 100644 index 000000000..a2344f585 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/setup_lti_store.rst @@ -0,0 +1,169 @@ +.. _Set up a Reusable LTI Store: + + +Set up a Reusable LTI Store +########################### + +.. tags:: educator, how-to + +The Reusable LTI Store centralizes LTI configuration in Django Admin. +Course authors then reference a single reusable configuration in Studio (via the LTI Consumer component). +A single configuration can be referenced multiple times, eliminating repeated copy/paste of tool credentials. + + +Overview +******** + +The Reusable LTI Store allows operators and course authors to simplify setup by: + +* Defining LTI configurations once in Django Admin. +* Allowing course authors to reference those configurations in Studio. +* Reducing errors and duplication of tool credentials. + +This feature supports LTI 1.3 integrations and is particularly useful for institutions running multiple courses with the same tool. + + + +Before you start +**************** + +To use the Reusable LTI Store, ensure the following: + +* You have an operational Open edX deployment. +* You have staff access to Django Admin (model-level access to ``lti_store``). +* You have access to an LTI 1.3 tool with: + + - Client ID + - Deployment ID + - OIDC/Authorization URL + - Launch URL + - JWKS (key set) URL or a tool public key + +* For Tutor-based deployments: You can install Tutor plugins. +* For non-Tutor deployments: You can install and configure Django apps. + + + +Install the LTI Store Tutor Plugin +********************************** + +1. Install the plugin from the `LTI Store Repository `_ and follow the plugin’s README to enable it for your environment. +2. Rebuild and restart your platform. Apply the plugin’s documented Tutor config, images rebuild, and services restart steps. + +.. note:: + For non-Tutor installations, follow `Non-Tutor Install Instructions `_. Most community operators use Tutor, but some large operators do not. + + + +Grant staff access for LTI Store administration +*********************************************** + +To create and manage reusable configurations: + +* Ensure the user has ``is_staff`` enabled. +* Assign permissions for the LTI Store models only (no superuser needed). +* This limits access to just the LTI Store configuration screens. + + +Create a reusable LTI configuration +*********************************** + +.. note:: + The following steps correspond to an **LTI 1.3 configuration**. + +#. Open Django Admin. +#. Navigate to: ``/admin/lti_store/externallticonfiguration/`` + (You must be logged in as a staff user with LTI Store model access.) + + +#. Add a new **External LTI Configuration**. + + .. image:: /_images/educator_how_tos/add_lti_store_configuration.png + :alt: 'Add External LTI Configuration' button on Django Admin + +#. Enter the required fields: + + * **Name** + * **Slug** (will be automatically generated from the name if left blank) + * **Version**: LTI 1.3 + * **LTI 1.3 Client ID**: Provided by the tool. + * **LTI 1.3 Deployment ID**: Provided by the tool. + * **LTI 1.3 OIDC URL**: Provided by the tool (sometimes called “OIDC auth URL”). + * **LTI 1.3 Launch URL**: The tool’s launch URL for LTI 1.3. + * **LTI 1.3 Private key**: Platform private key for this registration. Must be supplied manually. + You can generate these using the `IMS LTI Reference Implementation `_. + * **LTI 1.3 Tool Keyset URL** (recommended), or **LTI 1.3 Tool Public Key** + * **LTI 1.3 Redirect URIs**: Required by some tools. For many tools this matches the launch URL. + If not specified otherwise, use your launch URL in a JSON list. For example: + + ``["https://example.com/launch"]`` + + .. image:: /_images/educator_how_tos/create_ltistore_config.png + :alt: LTI store configuration fields in Django Admin + +#. Save the configuration. +#. After saving, note the **Filter key** displayed on the External LTI Configurations screen (``/admin/lti_store/externallticonfiguration/``). The Filter Key usually has the form ``lti_store:slug`` (e.g. ``lti_store:reference_tool``). You will use this value later in Studio when referencing this configuration from the LTI Consumer component. + + + +Recommended: Use the IMS LTI Reference Tool +=========================================== + +* For testing purposes, use the `Reference Tool `_ +* This page shows typical LTI 1.3 values (Client ID, Deployment ID, JWKS URL, OIDC URL, Launch URL). +* Prefer using the **JWKS (key set) URL** instead of a static public key to reduce manual steps and key rotation issues. +* You can also create your own tool for testing here. + + + +Best practices +============== + +* Use clear, consistent names for configurations and slugs (for example: ``tool-environment-purpose``). +* Keep a registry of created configurations (tool name, environment, slug, owner) to assist course teams. +* Create separate configurations per environment (production, staging, sandboxes) since Client ID and Deployment ID typically differ. + + + +Notes on current limitations and improvements +********************************************* + +* **Dynamic registration**: The LTI community is adopting dynamic registration, which allows configuring an LTI integration from a single URL. + This may simplify setup in future releases. The Open edX platform does not currently support dynamic registration. +* **Alternative reuse path**: Reusable Library Components may allow LTI reuse without the LTI Store. Investigation is ongoing; migration guidance will be provided if this path becomes preferred. + + + +Next steps +********** + +* Share the Filter key with course authors. +* Authors configure the LTI Consumer component in Studio to use this reusable configuration (documented separately). + + +.. seealso:: + + :ref:`Set up an LTI Consumer with Reusable LTI Configuration` (how-to) + + :ref:`LTI Component Settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Set up an LTI 1_1 component` (how-to) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) + + :ref:`Using Open edX as an LTI Tool Provider` (concept) + + + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| | | Ulmo | Draft | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/educators/how-tos/data/view_in_context_metrics.rst b/source/educators/how-tos/data/view_in_context_metrics.rst new file mode 100644 index 000000000..4e54a11e6 --- /dev/null +++ b/source/educators/how-tos/data/view_in_context_metrics.rst @@ -0,0 +1,101 @@ +.. _In-Context Analytics: + +View In-Context Analytics in Studio +###################################### + +.. tags:: educator, how-to + +In-Context Analytics introduces a new frontend plugin slot that can be used with +Aspects, customized to display metrics from other systems. + +#. After enabling, users will see a new Analytics button at the top of the page on + Course Outline and Unit pages. + + .. image:: /_images/release_notes/teak/in-context-analyticsbutton.png + :alt: A screenshot of the course outline page in Studio, highlighting the "Analytics" button in the top context menu + +#. Click the Analytics button to open an easy-to-access, easy-to-collapse sidebar + in Studio that displays content engagement and performance data alongside the + course outline, problem, and video components. + + .. image:: /_images/release_notes/teak/in-context-highlevelengagementcharts.png + :alt: A screenshot of the analytics sidebar, showing subsection, problem, and video engagement bar graphs + +#. Select the subsection or component of interest (scroll to the menu beneath the + engagement charts) to drill in to view more detailed data about a single graded + subsection, problem, or video. + + .. image:: /_images/release_notes/teak/in-context-subprobvid.png + +#. Select a graded subsection component to view the number of respondents in + each score range for the graded subsection as well as the average subsection + score for all learners who attempted at least one problem in the subsection. + The second chart shows the total number of correct and incorrect + responses for each problem in the subsection. + + .. image:: /_images/educator_how_tos/In_Context_Metrics_Graded_Subsection.png + +#. Navigate to a specific Unit. In comparison to the analytics provided on the + Course Outline page, the In-Context Analytics sidebar on the Unit page provides + more granular insight into how learners are engaging with a single course component + at a time. From the sidebar, users simply click on the component they want to + view more information about to see more detailed data for that component. + + .. image:: /_images/release_notes/teak/in-context-unitsidebar.png + :alt: A screenshot of the analytics sidebar in the context of editing a specific unit + +#. Select a specific problem to scroll the window to that component. The sidebar + will show the percentage of correct responses on the first problem attempt and on + all problem attempts, and a breakdown of initial responses for each individual + problem in the second table. + + .. image:: /_images/release_notes/teak/in-context-problemcomponent.png + :alt: A screenshot of the unit level analytics sidebar, showing the percentage of correct attempts and correct first attempts for a text input component + + .. note:: + The percentage of correct problem responses on the first attempt is a good indicator + of how difficult the problem is for the learners that submitted a response for + the problem, and whether or not a learner immediately + understands the question being asked/can identify the correct answer to the + question. The percentage correct on all problem attempts is an indicator of how + well learners were able to recover from earlier incorrect responses. A higher + percentage correct out of all problem attempts indicates that the learner is + able to figure out the right answer with additional effort or hints. If this + percentage is still low, the problem may be too difficult or confusing for + learners. + + The second table gives course delivery teams a peak into learners' thought + processes when they approached the problem for the first time. This breakdown + can give course authors quick insights into exactly how learners are getting a + problem wrong, especially for difficult problems. This data can point to course + delivery teams to where learners are getting mixed up. + +#. Select a specific video to scroll the window to that component. The sidebar + will show the number of unique and repeat views for a single video by + timestamp across the duration of the video. + + .. image:: /_images/release_notes/teak/in-context-videocomponent.png + :alt: A screenshot of the video editor with the in-context analytics sidebar, which shows a bar graph of unique vs repeat views in a bar graph by timestamp + + .. note:: + Timestamp ranges with a large number of repeat views should be + reviewed as this might be an indicator that this particular section of video is + unclear to learners. + +.. seealso:: + + :ref:`openedx-aspects:production_configuration` (how to) + + :ref:`openedx-aspects:In-Context Dashboards` (reference) + + :ref:`In-Context Analytics (Teak)` (reference) + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-06-06 | Data WG | Teak | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-10-21 | Data WG | Ulmo | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/educators/how-tos/set_up_course/require_entrance_exam.rst b/source/educators/how-tos/set_up_course/require_entrance_exam.rst index c8a23564a..85aef8b8d 100644 --- a/source/educators/how-tos/set_up_course/require_entrance_exam.rst +++ b/source/educators/how-tos/set_up_course/require_entrance_exam.rst @@ -8,7 +8,8 @@ Require an Entrance Exam .. admonition:: Turn on the Entrance Exam feature - In order for the Entrance Exam feature to work, it must be enabled on your Open edX instance. + In order for the Entrance Exam feature to work, it must be enabled on your Open edX instance. It is not enabled by default. + Please contact your site administrator to enable the `FEATURES['ENTRANCE_EXAMS'] `_ flag. To require an entrance exam, follow these steps. @@ -18,17 +19,29 @@ To require an entrance exam, follow these steps. #. On the **Schedule & Details** page, locate the **Requirements** section. #. Select the **Require students to pass an exam before accessing course materials** option. + + .. image:: /_images/educator_how_tos/require_entrance_exam.png + :alt: The "Require students to pass an exam before accessing course materials" checkbox appears at the bottom of the "Requirements" section. + +#. In the **Grade Requirements** section, set the percentage score required to + pass the exam (default is 50%). #. Select **Save Changes**. -After you save your changes, Studio automatically creates an **Entrance Exam** -section in your course outline. To add content to your entrance exam, go to the +After changes are saved, Studio automatically creates an **Entrance Exam** +section in the course outline. To add content to the entrance exam, go to the course outline. *********************** Create an Entrance Exam *********************** -You create your course entrance exam from the course outline in Studio. +Adding as Entrance Exam automatically places a new section called "Entrance +Exam" at the top of the course outline. + +.. image:: /_images/educator_how_tos/entrance_exam_in_outline.png + :alt: The "Entrance Exam" appears as a section at the top of the course outline, above all other course sections + + Creating entrance exam content is just like creating other course content. For more information, see the section on :ref:`Content Creation and Management `. @@ -36,29 +49,34 @@ more information, see the section on :ref:`Content Creation and Management + + The Open edX Teak release is out, featuring: + + 💡 Easier Content Reuse with Libraries! + + 📈 Analytics in Studio! + + 🏅 Badges for Learners! + + ... and lots more! :ref:`Continue reading... ` + .. grid-item-card:: :class-card: sd-shadow-md sd-p-2 :class-footer: sd-border-0 @@ -16,10 +36,10 @@ Open edX Documentation :maxdepth: 1 :caption: Quick Starts - Set up Open edX - Build a Course - Contribute to Open edX Code Base - Update the Documentation + Set up an Open edX Site + Build an Open edX Course + Contribute to the Open edX Code Base + Update the Open edX Documentation .. toctree:: :maxdepth: 1 diff --git a/source/learners/SFD_introduction.rst b/source/learners/SFD_introduction.rst index 0d32fb9fb..80ed5f84c 100644 --- a/source/learners/SFD_introduction.rst +++ b/source/learners/SFD_introduction.rst @@ -58,7 +58,7 @@ these options for getting an answer. .. note:: If you find an error or mistake in a course, contact the course staff by - using the :ref:`course discussions`. + using the :ref:`course discussions`. * Check the **Course** page in the course. Course teams use this page to post updates about the course, which can include explanations about course @@ -70,7 +70,7 @@ these options for getting an answer. general information about how the course works and what you can expect, and also what they expect from you, in the first section in the course. -* Participate in the :ref:`course discussions`. Other learners +* Participate in the :ref:`course discussions`. Other learners might be able to answer your question, or might have the same question themselves. If you encounter an unfamiliar word, phrase, or abbreviation, such as "finger exercise" or "board work", search for it on the diff --git a/source/learners/SFD_teams.rst b/source/learners/SFD_teams.rst index 373f05c29..e4aa97bd6 100644 --- a/source/learners/SFD_teams.rst +++ b/source/learners/SFD_teams.rst @@ -252,8 +252,7 @@ Although you can view discussions in any team, you must belong to a team to add new posts and responses to the team's discussion. Team discussions work in the same way as your course discussions. For -information about course discussions, see :ref:`Anatomy of Open edX Course -Discussions`. +information about course discussions, see :ref:`Getting started with Discussions`. If you leave a team, you can view posts that are made, but you can no longer participate in that team's discussions. diff --git a/source/learners/sfd_discussions/add_post.rst b/source/learners/sfd_discussions/add_post.rst deleted file mode 100644 index 04300e914..000000000 --- a/source/learners/sfd_discussions/add_post.rst +++ /dev/null @@ -1,302 +0,0 @@ -.. _Add or Edit a Contribution: - -####################################### -Taking Part in Course Discussions -####################################### - -This topic describes how to add, edit, and delete contributions to discussions. - -.. contents:: - :local: - :depth: 1 - -.. note:: - You might want to enter mathematical or scientific expressions in a - discussion. For information about how to enter plain text so that it will - appear as a formatted mathematical expression, see `Math Formatting in Course - Discussions`_. - -.. _Add a Post: - -************** -Adding a Post -************** - -When you add a post to a discussion in your course, you decide what type of -post to make and the topic of the post. For course-wide discussion topics, you -can add a post on the **Discussion** page. For content-specific discussions in -a course unit, you can add a post either on the **Discussion** page or -directly in the course unit. - -.. _Determine Post Type: - -************************************************** -Determining the Post Type: Discussion or Question -************************************************** - -To make sure that other learners and the course team can find and respond to -your post, decide what type of post you want to make: either question or -discussion. - -* A question post raises an issue so that the discussion moderation team or - community can provide answers. - -* A discussion post starts a conversation by sharing thoughts and - reflections, and inviting community participation. - -If you have any difficulty deciding which type of post you want to add, think -about whether you want to get concrete information (a question) or start an -open-ended conversation (a discussion). If you are asking a question about the -course and need an answer from the course team, be sure to create your post as -a question, so that the course team sees that a response is required and -responds appropriately. - -.. image:: /_images/learners/discussion_or_question.png - :width: 500 - :align: center - :alt: post type card on the add post section. - -After you make your post, on the **Discussion** page for your course, a -question mark next to the avatar identifies posts that ask questions. - -.. image:: /_images/learners/post_type_identification.png - :width: 700 - :align: center - :alt: how to identify type of past from summary list. - -.. note:: You can change the post type from discussion to question or vice - versa at any time after you add your post. For more information, see - :ref:`Edit or Delete`. - - -.. _Determine Post Topic: - -**************************** -Determining the Post Topic -**************************** - -Every post in the course discussions has an associated topic. The course team -creates the list of discussion topics for each course, and you choose a -topic from that list when you create your post. Before you add a post, you -should look through the list of topics in the course discussions so that you -can decide which topic is the most appropriate for your post. For more -information, see :ref:`Explore Posts`. - -After you decide on a post type and topic, you can add your post on the -**Discussion** page or in the body of the course. - - -.. _Add a post on discussion page: - -************************************ -Add a Post on the Discussion Page -************************************ - -You can add a post for course-wide or content-specific discussion -topics on the **Discussion** page. - -#. On the **Discussion** page, select **Add a Post**. - -#. Determine the type of post you want to make, and select **Question** or - **Discussion**. - -#. Determine the most appropriate topic for adding your post to, and select the - topic from the **Topic Area** list. - -#. In the **Title** box, enter a short, descriptive title. The title is the - part of your post that others see when they are browsing on the - **Discussion** page or scrolling through one of the content-specific topics. - -#. Enter the text of your post. To format the text or to add links or - images, use the formatting options above the text box. - - Any text formatting or images that you add are only visible when others - read your post in a web browser. The mobile app currently does - not display added formatting or images. - -#. Click the **Show preview** button to see how the post will look after submission. - -#. Click the **Submit** if you are satisfied with the appearance or click **Cancel**, if you want to discard the post. - -.. image:: /_images/learners/add_post_sections_details.png - :width: 700 - :align: center - :alt: identify different elements of post creation section. - -.. _Add image on a post: - -============================================ -Add Image to a Post on the Discussion Page -============================================ - -You can add an image while creating a post, click the **Insert image** button visible on top of the text editor to -open a dialog box. Use this dialog box to upload and resize the image and add description and source of the image. - -.. image:: /_images/learners/add_image_dialogue.png - :width: 500 - :align: center - :alt: dialogue box for adding images to post. - -.. note:: If you include an image with your post, include a description so - that learners who use screen readers to access the course can understand - the image's content and purpose. The description also displays in place - of the image if problems occur with the image file. If the image has no - functional purpose, leave the **Alternative description** field empty and check the image is decorative. - - The maximum size for an uploaded file is 1 MB. - -.. _add post in course unit: - -************************************ -Add a Post in a Course Unit -************************************ - -If you come to a discussion as you work through the units in your course, or -if you know where in the course a particular discussion originates, you can -add a post for that discussion from the unit in your course. - -The following steps apply only to content-specific discussions. - -#. Select **Course**. - -#. Open the unit in the course that includes the discussion topic that you - want to add a post to. - -#. Select **Show Discussion** to read what others have already contributed to - the conversation. - - The title and the first line of each post is shown in the list of posts. - - To read an entire post and view its responses and comments, select any part - of the post preview. - -#. To contribute a new post to the discussion, select **Add a Post** and follow - the steps that you use to add a post to the discussion page. For more - information, see :ref:`Add a post on discussion page`. - - To respond to an existing post or comment on an existing response, follow - the steps described in :ref:`Add response on discussion page`. - - -.. _Add image in course unit: - -===================================== -Add Image to a Post in a Course Unit -===================================== - -You can add an image while creating a post, click the Insert image button visible on top of the -text editor to open a dialog box. Use this dialog box to upload and resize the image and add -description and source of the image. - - -.. note:: If you include an image with your post, include a description so that learners who use - screen readers to access the course can understand the image’s content and purpose. The description - also displays in place of the image if problems occur with the image file. If the image has no - functional purpose, leave the **Image Description** field empty and select - **This image is for decorative purposes only and does not require a description**. - - The maximum size for an uploaded file is 1 MB. - - -.. _Posting Anonymously: - -********************** -Posting Anonymously -********************** - -If the course staff has enabled the option to allow anonymous posts, a **Post anonymously to peers** checkbox -will be available under the field where you enter your text, when creating a post. When you post anonymously, -the course team and discussion moderation team including community TAs can see your username, but other learners cannot. - -.. image:: /_images/learners/anonymous_post_card.png - :width: 500 - :align: center - :alt: anonymous post summary card view. - -.. _Add response on discussion page: - -************************************************** -Add a Response or Comment on the Discussion Page -************************************************** - -You can add a response or comment to course-wide or content-specific -discussion topics on the **Discussion** page. - -#. On the **Discussion** page, find the post that you want to contribute to. To - help you decide where to add your thoughts, review the current responses and - their comments. - - For more information about finding posts by searching, sorting, or using - filters, see :ref:`Explore Posts`. - -#. Add a response or comment. - - * To add a response to the post, select **Add A Response**. When you have - finished entering your response, select **Submit**. - - * To add a comment to a response, move your cursor inside the **Add a - comment** field below the response. When you have finished entering your - comment, select **Submit**. - -.. _add response in post in course unit: - -******************************************* -Add a Response or Comment in a Course Unit -******************************************* - -You can add a response or comment to a content-specific discussion -topic inside the course. - -#. In the unit that contains the discussion topic where you want to make - your contribution, select **Show Discussion**. - -#. Select the post that you want to contribute to. To help you decide - where to add your thoughts, review the current responses and their comments. - -#. Add a response or comment. - - * To add a response to the post, select **Add A Response**. When your - response is complete, select **Submit**. - - * To add a comment to a response, select inside the **Add a comment** field - below the response. When your comment is complete, select **Submit**. - -.. _Edit or Delete: - -******************************************* -Edit or Delete a Post, Response, or Comment -******************************************* - -You can only edit or delete your own posts, responses, or comments. You cannot -edit or delete contributions from other learners. - -#. Locate the contribution that you want to edit or delete, either in the body - of the course or on the **Discussion** page. - -#. In the top-right corner of the contribution, open the actions menu by clicking on the three dots (...) - -.. image:: /_images/learners/post_actions_menu.png - :width: 500 - :align: center - :alt: Response with the "More" menu expanded, showing Edit, Delete, and - Report options. - -#. Edit or delete the contribution. - - * To edit the contribution, select **Edit**, make the changes that you want - in the text editor that opens, and then select **Submit**. For - posts, you can change the post topic and the post type as well as the text - of the post. - - * To delete the contribution, select **Delete**, and then select **Delete** in - the confirmation box. - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/anatomy.rst b/source/learners/sfd_discussions/anatomy.rst deleted file mode 100644 index fa7be09e8..000000000 --- a/source/learners/sfd_discussions/anatomy.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. _Anatomy of Open edX Course Discussions: - -####################################### -Anatomy of Course Discussions -####################################### - -This section describes the structure and elements of course discussions. - -.. contents:: - :local: - :depth: 1 - -For information about how to participate in course discussions, see :ref:`Add -or Edit a Contribution`. - -.. _Basic Elements of Course Discussions: - -****************************************************** -Basic Elements: Topics, Posts, Responses, and Comments -****************************************************** - -The following example shows the different ways that you can contribute to a -discussion. - -:: - - Post: "Please introduce yourself." - - Response: "My name is Lee and I teach secondary school maths in Canberra, - Australia." - - Response: "Hello everyone, I am Sumei from Hong Kong, China." - - Comment: "Hi Sumei, I am taking this course in Hong Kong too. Maybe we - should make a study group!" - - Comment: "I'd like to join the Hong Kong study group too, I think it - will help me keep up with the homework." - - Response: "Hi from Johannesburg! I am taking the course to prepare for my - matric exams." - - -A post initiates the conversation, responses are replies to a post, and -comments expand on specific responses. Before you add a post, response, or -comment to your course discussion, take a moment to consider which of these -options best suits the contribution that you want to make. This helps keep -course discussions organized and easy to follow. - -Every post is associated with a topic, chosen from the list of topics created -by the course team. For information about topics, see :ref:`About Discussion -Topics`. - -For more information about joining the discussions in your course, see -:ref:`Explore Posts` and :ref:`Add or Edit a Contribution`. - - -.. _About Discussion Topics: - -==================================== -Discussion Topics -==================================== - -Discussion topics are created by the course team and organize all posts in the -course discussion. Discussion topics can be course-wide or content-specific. - -* Course-wide discussion topics cover matters that affect the entire course, - and can include topics such as "Frequently Asked Questions" and - "Troubleshooting". In the discussion navigation pane, course-wide topics do - not have other topics indented below them. - -* Content-specific discussion topics are added as part of a course unit, and - relate to specific video lectures, reading assignments, homework problems, - or other course content. In the discussion navigation pane on the - **Discussion** page, content-specific topics are indented under an identifying - category name. - -For course-wide topics, you read or add posts, responses, and comments on the -**Discussion** page. For content-specific discussion topics, you can read or -add posts, responses, and comments both on the **Discussion** page and in the -discussion that is embedded in the course unit on the **Course** page. - -Before you add a post, look through the topics. When you add your post to the -most appropriate topic, others with the same interest can find, read, and -respond to it more easily. - -==================================== -Types of Discussion Posts -==================================== - -When you make a contribution in a course discussion topic, you add your post -as either a question or a discussion. - -* A question post raises an issue so that members of the discussion - administration team and the course community can provide answers. - -* A discussion post starts a conversation by sharing thoughts and reflections, - and inviting community participation. - -When you add a post to a discussion topic, you must specify whether it is a -question or a discussion. - -On the **Discussion** page for your course, a question mark icon identifies -posts that ask questions and a conversation bubble icon identifies posts that -start discussions. - -If you have any difficulty deciding which type of post you want to add, think -about whether you want to get concrete information (a question) or start an -open-ended conversation (a discussion). If you require an answer from the -course team, be sure to create your post as a question, so that the course -team sees that a response is required and responds appropriately. - -******************** -The Discussion page -******************** - -You browse and contribute to course discussions on the **Discussion** page for -your course. Discussions page is broadly divided into three areas, as seen below: - -1. Navigation bar: For navigating forum content like threads, topics, learners, post creation etc. -2. Content view area: To view posts, responses and comments -3. Content list area: List of posts, learners, topics, search results etc. - -.. image:: /_images/learners/discussion_page.png - :width: 600 - :alt: Different elements of Discussion Experience. - -.. _Discussion Navigation Pane: - -=========================== -Discussion Navigation Pane -=========================== - -Use tabs on top of the Discussions page to access forum content in your course: - - * **All posts** tab lists all the posts in the course. - * **My posts** tab lists all the posts that you have created. - * **Topics** tab lists all discussion topics in the course. - -'''''''''''''' -All posts tab -'''''''''''''' - -The **All posts** tab shows the list of all posts in the forum for this course. -Post summaries in the list show various icons and labels to provide you with information about the status or content of posts: - -1. Post summary shows title, author and the beginning of the post content. - -2. Summary for a post that you have not read appears with a white background and bold title font. - -3. Summary for a post that you have read appears with a gray background. - -4. A “question mark” icon next to the avatar indicates that a post is a question. For more information, see :ref:`Determine Post Type`. - -5. The response or comment count indicator shows the number of responses and comments for a post. - -6. The number of new responses or comments that were added after you previously read a post is displayed next to the response count indicator. For more information, see :ref:`Keep Up with New Activity`. - -7. A “Pinned” icon shows that a post has been pinned by moderators so that it always stays at the top of the topic list regardless of sort order. - -8. A filled "star" button indicates that you are following the post. You can click on the button to follow/unfollow the post. By default, you’ll be following the posts that you have created. - -9. A filled "like" button indicates that you have liked the post. You can click the like button to like and unlike a post. The count next to the like button indicates how many likes does the post have. - -10. The “Staff” or “TA” label next to the username indicates that the user belongs to the course team or has a community teaching assistant (TA) role, respectively. - -11. The “Answered” label on summary of a question and indicates that a response to this question has been marked as an answer by a user having moderation privileges. - -12. Time elapsed since post creation is visible on the bottom right of the post summary. Hovering over the time will show the exact timestamp of post creation. Symbols “s”, “m”, “h”, “w” and “y” in time elapsed info indicate seconds, minutes, hours, weeks and years respectively. - -A labeled screenshot of features described above, is presented below: - -.. image:: /_images/learners/post_summary_labelled.png - :width: 300 - :alt: image to describe all the possible parts of side navigation bar of discussion experience. - -'''''''''''' -My post tab -'''''''''''' -**My posts** tab shows a list of all posts that you have created. You can use this tab to follow up on your forum contributions. - -''''''''''' -Topics tab -''''''''''' -The **Topics** tab lists all the discussion topics in your course. -Course-wide discussion topics appear on top of the list followed by content specific discussion topics.You can click on each topic to see the posts in that topic. -To learn more about exploring content in topics, see :ref:`Discussion Topics`. - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/discussions_notifications.rst b/source/learners/sfd_discussions/discussions_notifications.rst new file mode 100644 index 000000000..e40b6822d --- /dev/null +++ b/source/learners/sfd_discussions/discussions_notifications.rst @@ -0,0 +1,51 @@ +.. _Staying Updated with Notifications: + +################################## +Staying Updated with Notifications +################################## + +Discussion notifications keep you informed when others interact with your posts or when instructors share updates. + +.. contents:: + :local: + :depth: 1 + + +There are four notification preferences for Discussions: + +1. **Activity notifications**: Notifies you of all activity related to posts or responses you've authored or are following. +2. **New posts from instructors**: Notifies you when an instructor creates a post. +3. **New discussion posts**: Notifies you when someone creates a new discussion type post. +4. **New question posts**: Notifies you when someone creates a new question type post. + +Table in the image below shows which activity types trigger notifications. Several activity types are grouped +into a single preference to avoid clutter in preferences. + +.. figure:: /_images/learners/Discussions_notification_activity.png + :alt: Table listing discussion activity types, their preference names, recipients and defaults + :width: 600 + :align: center + + Table listing discussion activity types, their preference names, recipients and defaults. + + +.. note:: Learn more about notifications in :ref:`Notifications & Preferences`. + + +.. seealso:: + + + :ref:`Getting started with Discussions` + + :ref:`Finding and Following the Right Conversations` + + :ref:`Taking Part in Discussions` + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 3rd Dec, 2025| Aamir Ayub | Ulmo | | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/explore_posts.rst b/source/learners/sfd_discussions/explore_posts.rst deleted file mode 100644 index b42b62560..000000000 --- a/source/learners/sfd_discussions/explore_posts.rst +++ /dev/null @@ -1,149 +0,0 @@ -.. _Explore Posts: - -########################### -Exploring Discussion Posts -########################### - -Finding out whether someone else has already asked the same question or -initiated a conversation about the subject that interests you, and then reading -and contributing to that exchange instead of starting a new one, helps make the -time that everyone spends with the course discussions more productive. You can -search for something specific, or you can browse through the posts in a single -discussion topic. - -.. contents:: - :local: - :depth: 1 - -For information about finding new or updated posts in discussions, see -:ref:`Keep Up with New Activity`. - -.. _Search Discussions: - -*********************** -Search Posts or Topics -*********************** -The **Search** field on top of the **Discussion** page enables you to search all posts, -the posts that you have created or discussion topics when *All posts*, *My post* or -*Topics tab* is selected, respectively. - -To search for all posts, responses, or comments containing a particular keyword or -phrase, select the *All posts* tab and enter the word or phrase, or a partial word in the **Search** -field at the top of the **Discussion** page. - -To search for a particular keyword or phrase in the posts that you have authored, -select the *My posts* tab and enter the word or phrase, or a partial word in the -Searchfield at the top of the **Discussion** page. - -To search for a discussion topic containing a particular keyword, select the -*Topics* tab and enter the word or phrase, or a partial word in the **Search** -field at the top of the **Discussion** page. - -Search results are displayed in the content list area. If an exact -match is not found, search results are shown for a similar value. - -.. _Discussion Topics: - -********************************************* -View Discussions about a Specific Topic -********************************************* - -Course discussions are organized by discussion topics, which are created by the -course team. Anyone who adds a post to the course discussions selects an -existing topic to associate their post with. For more information about topics, -see :ref:`Basic Elements of Course Discussions`. - -You can browse discussions by topic, to join the discussion on subjects that -interest you, or to see if anyone else in the course has asked the same -question. - -======================================= -View Topics on the Discussion Page -======================================= - -On the **Discussion** page, select the *Topics* tab in discussion navigation pane to see -all of the discussion topics in the course. Topics tab will list course-wide discussion -topics first, followed by content-specific discussion topics. Select a topic from the list -to see all posts associated with that topic. - -Note that course-wide topics do not have other topics indented below them, -while content-specific topics are indented under a category name. -You can also see the count of Discussion and Question type posts in each topic, in the topic list. - -.. image:: /_images/learners/topic_summary_diagram.png - :width: 400 - :alt: Discussion topic list expanded, showing all course discussion - topics. - -======================================= -View Topics in a Course Unit -======================================= - -Content-specific topics are located in specific units in the course. They -typically appear below the content they apply to. To access a content-specific -topic, view the unit that contains the topic. - -.. image:: /_images/learners/HTMLandDisc.png - :alt: A discussion topic that appears below text inside the course. - -You can also use the **Discussion** page to access a discussion in the unit -where that topic is located. - -#. In the list of topics, select the topic that you want. - -#. Select a post title to open the complete post and its responses and comments - next to the above the discussion navigation pane. - -#. In the text of a post, select the name of the discussion topic to go to the - discussion inside the unit. - - -***************************************** -Filter or Sort Posts -***************************************** - -You can filter or sort the posts in *All post*, *My post* and *Topics* tab in following ways: - -1. You can filter the posts by status: *Unread*, *Following* and *Unanswered* (question type posts only). -2. You can filter the posts by type: *Discussion* or *Question*. -3. You can sort the posts by *Recent activity*, *Most activity* and *Most likes*. - -By default, both types of posts are displayed, having any status and sorted by *Recent activity*. -In this context, activity means creation of the post itself or a response or comment on the post. - -.. image:: /_images/learners/filter_menu.png - :width: 700 - :alt: Discussion filters and sorting menu. - -***************************************** -View Pinned Posts -***************************************** - -Pinned posts appear at the top of the list of posts in *All posts*, *My posts* and *Topics* tab. -Pinned posts can contain important information about the course or any part of the course, such as a -particular video or problem. The pinned post can originate from anyone in the -course, including other learners or members of the discussion moderation team, -but only members of the moderation team can pin a post. -Look for the pin icon on top-right of the summary of a post to identify a pinned post. - -.. image:: /_images/learners/pin_post_icon.png - :width: 400 - :height: 700 - :alt: Discussion filters and sorting menu. - - -***************************************** -View Followed Posts -***************************************** - -In the discussion navigation pane select *All posts* tab and then select *Following* filter from the -filter menu. The content list area refreshes to show only posts that you are following. - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/find_follow_conversations.rst b/source/learners/sfd_discussions/find_follow_conversations.rst new file mode 100644 index 000000000..ecc407b42 --- /dev/null +++ b/source/learners/sfd_discussions/find_follow_conversations.rst @@ -0,0 +1,165 @@ +.. _Finding and Following the Right Conversations: + +############################################## +Finding and Following the Right Conversations +############################################## + +Discussions can grow quickly as a course progresses. +Knowing how to browse and search helps you save time and discover conversations that matter to you. + +.. contents:: + :local: + :depth: 1 + +.. _Navigating the Discussions page: + +******************************** +Navigating the Discussions page +******************************** + +.. figure:: /_images/learners/Discussions_page.png + :alt: Screenshot of the discussion page showing navigation pane, content list, and content view areas. + :width: 600px + :align: center + + The Discussion page showing navigation pane, content list, and content view areas. + + +When you open the Discussions tab in your course, you see four tabs at the top, as shown in the image below. + +1. **My Posts:** Shows all posts that you’ve written or taken part in through a response or comment. Click a post title in the left panel to open it and see its responses and comments. + +2. **All Posts:** Lists every post in the course discussions. By default, posts with the most recent activity appear at the top. + +3. **Topics:** Displays all discussion topics in the course. Topics follow the same three-level hierarchy as the course content: + + a. The top level represents course sections. + b. The second level shows subsections. + c. The third level lists units, which are the actual discussion topics that contain posts. Select a subsection to expand it and see its topics. When you click a topic name, you will see the posts related to it. + +4. **Learners:** Shows everyone who has written a post, response, or comment. Click a username to see their contributions. Under each name you can see the number of posts they created and their total contributions. + + +.. figure:: /_images/learners/Discussions_topics.png + :alt: Screenshot of 3 steps to navigate topics. + :width: 600 + :align: center + + Follow these steps to navigate the 3-level topic hierarchy to view posts belonging to a topic. + + +.. tip:: Use *My Posts* for tracking your own activity and *Topics* when you want to focus on the part of the course you are studying. + + +.. _Discussions inside course units: + +********************************* +Discussions inside course units +********************************* + +.. figure:: /_images/learners/Discussions_sidebar.png + :alt: Screenshot of Discussions sidebar on right side of course content. + :width: 600 + :align: center + + You can use Discussions sidebar to create or browse posts belonging to the course unit being viewed. + +Some course units include a discussion panel on the right side of the page. It shows only the posts related to that +unit’s topic, giving you a focused view of the conversation. Any post you create here also appears on the main +Discussions page. + +.. tip:: Use the inline panel when you want to talk about something shown on the page. + Use the main Discussions tab when you want to search or browse across the entire course. + + +.. _Searching and filtering: + +************************ +Searching and filtering +************************ + +.. figure:: /_images/learners/Discussions_search.png + :alt: Screenshot of how scope of search changes based on what Discussions tab is selected. + :width: 400 + :align: center + + You can change scope of search by selecting any of the 4 tabs on discussions page. + + +The search field at the top of *Discussions* page lets you search for: + +1. Discussion content when you have *All Posts* or *My Posts* tab open +2. Discussion topics when you have *Topics* tab open +3. Discussion users when you have *Learners* tab open. You can search by full or partial usernames. + +.. figure:: /_images/learners/Discussions_filters.png + :alt: Screenshot of posts filter menu accessible from a button on top-right of post list. + :width: 400 + :align: center + + Use sorts and filters to find conversations you are interested in. + + +You can also filter or sort posts by clicking the Filter icon in the top right of the post list panel: + +* Filter by type: *Discussion* or *Question*. +* Filter by status: *Unread*, *Following*, *Unanswered* or *Not responded*. +* Sort by: *Recent activity*, *Most activity*, or *Most likes*. + +By default, all post types and statuses are displayed, sorted by recent activity. + +You can also sort individual responses by date created, from within the post itself, as shown in the image below. + +.. figure:: /_images/learners/Discussions_response_sort.png + :alt: Screenshot of response sort option on top right of responses. + :width: 400 + :align: center + + Use response sort option to sort responses by date created. + + +.. _Viewing pinned and followed posts: + +***************************************** +Viewing pinned and followed posts +***************************************** + +.. figure:: /_images/learners/Discussions_pinned_following.png + :alt: Screenshot showing identifiers for pinned and followed discussions. + :width: 400 + :align: center + + Pinned posts appear on top of the list and followed posts display a filled star icon. You can filter for + followed posts from the filter menu. + + +Instructors and moderators can pin posts. These posts stay at the top of every list. +They often contain key announcements or resources from the course team. + +Posts you are following display a filled star icon in post list and at the bottom of the post. To view only +those, open the *All Posts* tab and apply the *Following* filter. Follow posts that relate to your project +or assignment so that you get updates when new responses arrive. + +By default, you are following every post that you author. + +.. note:: You will receive notifications of any activity on posts that you are following. + Learn more in :ref:`Staying Updated with Notifications`. + + +.. seealso:: + + + :ref:`Getting started with Discussions` + + :ref:`Taking Part in Discussions` + + :ref:`Staying Updated with Notifications` + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 3rd Dec, 2025| Aamir Ayub | Ulmo | | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/getting_started.rst b/source/learners/sfd_discussions/getting_started.rst new file mode 100644 index 000000000..ca3802d7c --- /dev/null +++ b/source/learners/sfd_discussions/getting_started.rst @@ -0,0 +1,118 @@ +.. _Getting started with Discussions: + +################################## +Getting started with Discussions +################################## + +This section describes where to find discussions and the structure and elements of course discussions. + +.. contents:: + :local: + :depth: 1 + + +.. _Where to Find Discussions: + +************************** +Where to find Discussions +************************** + +You can access course discussions in two ways: + +=========================== +From the course navigation +=========================== + +.. figure:: /_images/learners/Discussions_course_nav.png + :alt: Screenshot of Discussions page that is accessible from course navigation bar. + :width: 600px + :align: center + + Click on Discussions tab in course navigation bar to access the Discussions page. + +Click the **Discussions** tab at the top of your course. This opens the full discussion page, +where you can browse all topics, search, and post new questions or discussions. + +If you don't see this tab, its means your instructor has not enabled discussions for your course. + + +=========================== +From within a course unit +=========================== + +.. figure:: /_images/learners/Discussions_sidebar.png + :alt: Screenshot of discussions panel on the right side of course content. + :width: 600px + :align: center + + Click on the discussions icon on top-right to open or close the Discussions panel. + + +Some course units include a discussion panel on the right side of the page. +You can use this panel to read or take part in discussions related specifically to that unit. + +If you don’t see this panel, it may be because: + +a. Discussions aren’t enabled for that unit. This is common for assignments or exams. + You can still use the main *Discussions* tab to participate in other discussions. + +b. The panel is collapsed. Look for a button in the upper-right corner of the page + (as shown in the image below). Click it to expand the discussion panel. + +Remember that this panel only shows posts related to the course unit you are on. + + +.. figure:: /_images/learners/Discussions_collapsed_sidebar.png + :alt: Screenshot of collapsed discussions panel and button to open it. + :width: 600px + :align: center + + Click on the highlighted button on the top right to open the discussions panel. + + +.. _Basic elements: + +*************** +Basic elements +*************** + +.. figure:: /_images/learners/Discussions_elements.png + :alt: Labelled screenshot of a discussion thread showing post, response, comment and topic. + :width: 600px + :align: center + + A discussion thread consists of a post and its topic and can have responses and comments on those responses. + + +Each discussion has the following components: + +#. **Post**: The question or idea that someone shares. A post starts a discussion. It has a title, + name of the author, its type (question or discussion) and the topic it is linked to. + +#. **Topic**: A topic indicates what the post is about. Every post belongs to a topic. Topics group + related discussions together and help you browse and keep course conversations organized. For example, *Week 2: Problem Set 1*, *General Questions*, or *Feedback*. + +#. **Response**: Other learners or course staff can write responses to a post. Responses add explanations, + share experiences, or suggest solutions. They sit directly under the original post. + +#. **Comment**: Within each response, learners can add comments. These are follow-ups that keep side + conversations contained and easy to read. Comments add context within a single response. + + +.. seealso:: + + + :ref:`Finding and Following the Right Conversations` + + :ref:`Taking Part in Discussions` + + :ref:`Staying Updated with Notifications` + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 3rd Dec, 2025| Aamir Ayub | Ulmo | | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/index.rst b/source/learners/sfd_discussions/index.rst index 33022c2b0..14bb95a83 100644 --- a/source/learners/sfd_discussions/index.rst +++ b/source/learners/sfd_discussions/index.rst @@ -14,8 +14,7 @@ participation more effective. .. toctree:: :maxdepth: 1 - anatomy - explore_posts - add_post - keep_up - provide_feedback + getting_started + find_follow_conversations + take_part_in_discussions + discussions_notifications \ No newline at end of file diff --git a/source/learners/sfd_discussions/keep_up.rst b/source/learners/sfd_discussions/keep_up.rst deleted file mode 100644 index a012cabe8..000000000 --- a/source/learners/sfd_discussions/keep_up.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. _Keep Up with New Activity: - -################################ -Keeping Up with New Activity -################################ - -This topic describes how to keep up with discussion activity in your Open edX -course. - -.. contents:: - :local: - :depth: 1 - -.. _Read New or Updated Posts: - -**************************** -Reading New or Updated Posts -**************************** - -The list of posts in the discussion navigation pane on the **Discussion** page -provides visual cues to help you distinguish posts that are new, or that have -responses or comments that you have not read yet, from exchanges that you have -already read completely. For information about the labels and icons used in -posts, see :ref:`Discussion Navigation Pane`. - -==================== -Sorting by Activity -==================== - -In the discussion navigation pane you can sort posts by activity. To do this, -select the drop-down list of sorting options at the top of the discussion -navigation pane and select either **by recent activity** or **by most -activity**. - -Sorting by recent activity changes the order of the posts so that the post that -was most recently updated appears at the top of the list. Updating includes -having responses or comments added. - -Sorting by most activity changes the order of the posts so that posts with the -most responses or comments appear at the top of the list. - - -================== -Sorting by Likes -================== - -In the discussion navigation pane you can sort posts by the number of likes -received. To do this, select the drop-down list of sorting options at the top -of the discussion navigation pane, and select by **Most Likes**. - -Sorting by the most likes changes the order of the posts so that posts that -have received the most likes appear at the top of the list. - -For more information about voting for posts, see :ref:`Like Posts or Responses`. - -.. _Receiving Discussion Notifications: - -***************************** -Receiving Notifications -***************************** - -When you add a post to a discussion, you might receive an email notification -about the first reply to the post. - -============================== -Receiving Email Notifications -============================== - -If your course is set up to send email notifications for discussion posts, -the first time another learner or member of the course team responds to a -post that you have made, you receive an email notification. - -.. Re: the above: It's technically the *platform* and not the course that would -.. be set up to send email notifications, but that won't matter to Open edX -.. learners and would be more complicated to explain. - -You only receive an email notification for the first response. - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/provide_feedback.rst b/source/learners/sfd_discussions/provide_feedback.rst deleted file mode 100644 index 0d890d36b..000000000 --- a/source/learners/sfd_discussions/provide_feedback.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _Provide Feedback: - -############################################### -Providing Feedback on Contributions -############################################### - -As you read the contributions that other learners and course team members make -to discussion topics, you can provide feedback in other ways than writing a -complete response or comment. - -.. contents:: - :local: - :depth: 1 - -**************** -Feedback Options -**************** - -When you open a post, response, or comment, the **Like** and **Follow** -feedback option icons appear at the top right. Move your cursor over these -icons to show the full label. - -.. image:: /_images/learners/discussion_feedback_options.png - :width: 300 - :align: center - :alt: The "Like", "Follow", feedback icons in a post, response, or comment. - -.. _Like Posts or Responses: - -************************************ -Like Posts or Responses -************************************ - -To provide positive feedback for a post or one of its responses, you can like -it. Open the post or response, and click the thumbs up icon next to the -number of **Likes**. - -In the discussion navigation pane, you can sort the list of posts so that the -posts with the most likes appear at the top. To do this, select the drop-down -list of sorting options and select **Most Likes**. For more information -about ways to sort the list of discussion topics, see :ref:`Read New or -Updated Posts`. - - -.. _Follow Posts: - -************************************ -Follow Posts -************************************ - -If you find a conversation or question particularly interesting, you can -follow it so that you can return to it easily. - -To follow a post, move your cursor over the star icon for the post, and then -select **Follow**. - -Each post that you follow appears with a *Filled Star* indicator in the list of -posts. - -In the discussion navigation pane, you can list only the posts that you are -following, regardless of the discussion topic they apply to. To do this, -select **All Posts** tab and then select **Following** filter from list. - - -.. _Answer Questions: - -******************************************************** -Answer Questions and Mark Questions as Answered -******************************************************** - -Anyone in a course can answer questions that are posted in the course -discussions. To respond to a question that has been asked by someone else in -the course, add a response with your answer to the question post. - -If you have received a helpful or correct response to a question that you -yourself have asked, you can mark the response as the correct answer. To do -this, open actions menu by clicking top right icon on the response and select **Mark as Answered**. - -.. image:: /_images/learners/mark_as_answered_option.png - :width: 500 - :align: center - :alt: the image showing mark as answered response options - -.. note:: The discussion moderation team can mark any response as correct. - Learners can only mark responses as correct for their own posts. - -After at least one response to a question post is marked as answer, a -label is added to the post summary card in the discussion navigation pane. - -.. image:: /_images/learners/answer_label.png - :width: 300 - :align: center - :alt: the image showing mark as answered response options - -.. _Report Discussion Misuse: - -************************************ -Report Discussion Misuse -************************************ - -On rare occasions you might come across a discussion contribution that is -inappropriate. You can flag any post, response, or comment for a discussion -moderator to review. To do so, open the contribution, select top right icon to open actions menu, and then -select **Report**. - -The discussion moderation team can investigate any flagged posts, responses, -or comments and take the appropriate action. - - - -.. Future: DOC-121 As a course author, I need a template of discussion guidelines to give to students - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/learners/sfd_discussions/take_part_in_discussions.rst b/source/learners/sfd_discussions/take_part_in_discussions.rst new file mode 100644 index 000000000..dba935909 --- /dev/null +++ b/source/learners/sfd_discussions/take_part_in_discussions.rst @@ -0,0 +1,262 @@ +.. _Taking Part in Discussions: + +############################ +Taking Part in Discussions +############################ + +This topic explains how to create, edit, and manage your contributions in course discussions. +You can start a new post, respond to others, or help moderate discussions by reporting issues. + +.. contents:: + :local: + :depth: 1 + + +.. _Creating a post: + +************************* +Creating a post +************************* + +.. figure:: /_images/learners/Discussions_creating_post.png + :alt: Screenshot of form to create a post, on the Discussions page and alongside course content. + :width: 600 + :align: center + + Form to create a discussion post on the Discussions page and in a course unit. By default, you are following + the posts that you author. + +A post starts a new conversation. + +1. Choose the right type before you post: + + - **Question:** when you need an answer or clarification. + - **Discussion:** when you want to share an idea or start a conversation. + +2. Select a topic that fits your post so others can find it easily. + +3. Add a short, clear title that describes what your post is about. + +4. Write your description. Use the toolbar to format text or insert images if needed. + +5. Click *Show preview* (bottom right corner) to check your post before submitting. + +6. If anonymous posting is enabled, you will see a *Post anonymously to peers* checkbox. + When selected, your post appears anonymous to peers, but your identity remains visible to course staff and moderators. + Some courses do not allow anonymous posting. + +7. Click *Submit* to publish your post. You can edit it later if needed. + + +.. Tip:: + You can subscribe to notifications for new discussions or new question posts from the Preference Center. + See :ref:`Staying Updated with Notifications`. + + +.. _Responding and commenting: + +************************* +Responding and commenting +************************* + +.. figure:: /_images/learners/Discussions_response_comment.png + :alt: Screenshot of responses and comments on a discussion thread, on Discussions page and in sidebar. + :width: 600 + :align: center + + Option to create responses on a discussion thread can be found in actions menu on mouse hover or + at the bottom of the thread. Option to create comments can only be found in actions menu. + + +You can add to an existing conversation by writing a response or a comment. + +- A **response** adds your full reply or answer to the main post. +- A **comment** adds a short note or clarification inside a specific response. + +Open a post, write your response or comment, and click *Submit*. + +.. note:: + You will receive a notification when someone creates a response or a comment on your post or response. + See :ref:`Staying Updated with Notifications`. + + +.. _Editing or deleting your own contributions: + +******************************************** +Editing or deleting your own contributions +******************************************** + +.. figure:: /_images/learners/Discussions_edit_delete.png + :alt: Screenshot of actions menu with options to edit or delete content you've authored. + :width: 600 + :align: center + + Use the options menu to edit or delete content that you've authored. + + +You can edit or delete any post, response, or comment that you have written. +Use the *Actions* menu on your contribution to make changes. + +Be careful when deleting content: + +- Deletion is permanent and cannot be undone. +- Deleting a post or response deletes all its responses and comments. + + +.. _Endorsements and accepted answers: + +******************************************* +Endorsements and accepted answers +******************************************* + +.. figure:: /_images/learners/Discussions_endorsed.png + :alt: Screenshot of responses showing an endorsed and marked-as-answer banner on top. + :width: 600 + :align: center + + Responses that are endorsed or marked as answers display a banner on top. + + +Forum moderators can endorse responses in discussion posts or mark them as the answer in question posts. +Endorsed or marked responses highlight accurate or especially helpful information, and appear with a banner on top. + +If you created a question post, you can mark a response as the answer yourself, as shown below. + + +.. figure:: /_images/learners/Discussions_mark_answer.png + :alt: Screenshot of actions menu showing option to mark a response as answer on a post you've authored. + :width: 400 + :align: center + + Use the options menu to mark a response as answer on a question post you authored. + + +.. figure:: /_images/learners/Discussions_mark_answer_indicator.png + :alt: Screenshot of posts list showing a check mark on a question that has been answered. + :width: 400 + :align: center + + Question posts that have been answered have a check mark in the posts list. + + +.. note:: + You will receive a notification if your response is endorsed or marked as the answer, + or if a response on your post is endorsed or marked as the answer. + See :ref:`Staying Updated with Notifications`. + + +.. _Liking posts and responses: + +******************************* +Liking posts and responses +******************************* + +.. figure:: /_images/learners/Discussions_likes.png + :alt: Screenshot of actions menu showing option to like a post or response. + :width: 400 + :align: center + + Post or response can be liked using the actions menu. + + +You can click the *Like* button on any post or response to show appreciation for helpful or well-written +contributions. Posts with more likes appear higher in lists sorted by *Most likes*. Count of likes can been seen +below the response or comment. + + +.. _Reporting inappropriate content: + +******************************* +Reporting inappropriate content +******************************* + +.. figure:: /_images/learners/Discussions_report_content.png + :alt: Screenshot of actions menu showing option to report content. + :width: 600 + :align: center + + Use the options menu to report content that you find inappropriate or spam. + +.. figure:: /_images/learners/Discussions_reported_banner.png + :alt: Screenshot of post showing banner on top indicating that you have reported it. + :width: 600 + :align: center + + Content that *you* report will show an indicator on top of the post and in the list. + + +If you see a post, response, or comment that is inappropriate, off-topic, or spam, report it for review. +Open the *Actions* menu on that item and select *Report*. + +Moderators review reported content and may edit, delete, or close it to keep discussions safe and respectful. + + +.. _Moderation actions: + +****************************** +Moderation actions +****************************** + +Moderators help maintain a respectful learning environment. +They can close posts to prevent new replies, or edit or delete content. + +=========================== +When a post is closed +=========================== + + +.. figure:: /_images/learners/Discussions_post_closed_banner.png + :alt: Screenshot of a closed post with a lock icon and a banner explaining why it was closed. + :width: 600 + :align: center + + Closed post will show a lock icon on the bottom right and a banner on top with information on why it was closed. + + +A closed post shows a lock icon at the bottom right corner. +If you are the author, a banner appears at the top explaining why the post was closed. + +Moderators might close posts for reasons that include: they are off-topic, duplicates, resolved, or related to graded +assignments or exams. Closed posts can be reopened by moderators if needed. + +A closed post shows a lock icon at the bottom right corner. +If you are the author, a banner appears at the top explaining why the post was closed. + +Moderators may close posts that are off-topic, duplicates, resolved, or related to graded assignments or exams. +Closed posts can be reopened by moderators if needed. + +============================ +When a post is edited +============================ + +.. figure:: /_images/learners/Discussions_edited_post_banner.png + :alt: Screenshot of post edited by a moderator showing a banner with the reason for the edit. + :width: 600 + :align: center + + Post edited by a moderator will show a banner on top with reason for edit. + + +Moderators can edit posts, responses, and comments to fix spelling, remove personal or identifying details, +or delete harmful or inappropriate content. + +If you are the post’s author, a banner appears at the top explaining why your post was edited. + + +.. seealso:: + + + :ref:`Getting started with Discussions` + + :ref:`Finding and Following the Right Conversations` + + :ref:`Staying Updated with Notifications` + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release | Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 3rd Dec, 2025| Aamir Ayub | Ulmo | | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/learners/sfd_notifications/index.rst b/source/learners/sfd_notifications/index.rst index 894e4ec7c..ab4fae95d 100644 --- a/source/learners/sfd_notifications/index.rst +++ b/source/learners/sfd_notifications/index.rst @@ -1,153 +1,157 @@ +.. _Notifications & Preferences: + ########################### Notifications & Preferences ########################### -Notifications keep you informed about activity in your courses. +Notifications help you stay informed about activity in your courses. You can view notifications while on the +platform or receive them by email, depending on your preferences. -.. _notification-types: +.. contents:: + :local: + :depth: 1 -Notification Types -================== +.. _where-notifications-appear: -Discussion Notifications ------------------------- +Where Notifications Appear +=========================== -#. Activity notifications: New responses or comments on your posts and on posts you follow, and endorsements **of** your responses and of responses on your posts. -#. New discussion posts: When a new discussion post is created. -#. New question posts: When a new question post is created. -#. New posts from instructors: When the instructor creates a post and chooses to notify learners. +Notification Tray +------------------ -.. image:: /_images/learners/Notification_tray_forum_notifications_learner.png - :width: 400 - :align: center - :alt: Clicking the bell on the top right opens the notifications tray. +.. figure:: /_images/learners/Notifications_tray_screenshot.png + :alt: Screenshot of notifications tray showing it's features. + :width: 600 + :align: center -Updates -------- + Clicking the bell icon on top right opens the notifications tray. Next to bell icon is the count of + unseen notifications. -#. Course updates: When the instructor creates a new course update. +The notification tray keeps you updated while you’re browsing the site. -.. image:: /_images/learners/Notifications_tray_updates_screenshot.png - :width: 400 - :align: center - :alt: Screenshot of a course update notification in the tray. +- Clicking the bell icon on top right opens the notifications tray with tabs such as Discussions, + Updates and Grading. +- Each notification shows the course it belongs to, time elapsed since it was created + and an red dot that indicates that it has not been clicked. +- A gear icon in the tray takes you directly to your notification preferences on Account Settings page. -Grading -------- +If you have more notifications than can fit in the tray, a “Load more” button appears at the bottom. +Clicking it loads mores notifications at the bottom. -#. ORA grade received: When your submission for an open response assessment (ORA) receives a grade. +Email Notifications +------------------- -.. image:: /_images/learners/Notifications_tray_grading_screenshot_learner.png - :width: 400 - :align: center - :alt: Screenshot of grading notifications in the tray. +.. figure:: /_images/learners/Notification_daily_email_screenshot_learner.png + :alt: Screenshot of an email with the daily summary of notifications. + :width: 400 + :align: center -.. _delivery-channels: + Screenshot of email containing daily summary of notifications from the past 24hrs. -Delivery Channels -================= +Notification emails keep you informed when you are away from the platform. You can choose to get notified immediately +or receive a daily or weekly summary of notifications. -Tray ----- +- **Immediately:** Receive the email notification as soon as the activity happens. +- **Daily:** Receive a summary of notifications from the past 24 hours. +- **Weekly:** Receive a summary of notifications from the past 7 days. -- The notification tray is intended to keep users informed while they are on the web platform. -- A bell icon in the top-right corner displays the count of unread notifications. -- When clicked, it opens a tray that organizes notifications into tabs based on platform area (Discussions, Grading, Updates). -- Each notification includes the relevant course name, an indicator showing it is unread, and a timestamp of when it was generated. -- A gear icon in the tray’s top-right corner links to the preferences center, where users can adjust notification settings. +Email summary contains upto 5 notifications for each platform area (Discussions, Updates, Grading). +Click the "View more" button to the see rest in the notifications tray on the website. -.. image:: /_images/learners/Notifications_tray_screenshot.png - :width: 700 - :align: center - :alt: Clicking the bell on the top right opens the notifications tray. +Emails include a one-click unsubscribe option to turn off email notifications for all activity types. -Email Notifications -------------------- +.. _activity-types: -- Notification emails keep users informed even when they are away from the platform. -- Users can choose to get notified immediately or receive a daily or weekly summary of notifications. +Activity Types +================ - - **Immediately:** Receive the email notification as soon as the activity happens. - - **Daily:** Receive a summary of notifications from the past 24 hours, every day at 22:00 UTC. - - **Weekly:** Receive a summary of notifications from the past 7 days, every Saturday at 22:00 UTC. +Activities for which you may be notified for, depending on your preferences, are listed in the table below. -- Emails include a one-click unsubscribe option to turn off email notifications for all activity types. -.. image:: /_images/learners/Notification_daily_email_screenshot_learner.png - :width: 400 - :align: center - :alt: Screenshot of an email with the daily summary of notifications. +.. list-table:: + :header-rows: 1 + :widths: 5 15 45 20 10 10 + + * - # + - Area + - Activity + - Preference name + - Tray default + - Email default + + * - 1 + - Discussions + - All activity on posts and responses that you've authored or you are following + - Activity notifications + - ON + - Daily -.. _managing-preferences: + * - 2 + - Discussions + - Any new discussion post + - New discussion posts + - OFF + - OFF -Managing Preferences -==================== + * - 3 + - Discussions + - Any new question post + - New question posts + - OFF + - OFF -The preferences center allows users to control which notifications they receive, how often, and through which channel. Users can get to the preferences page via: + * - 4 + - Discussions + - Your instructor created a post and chose to notify everyone + - New posts from instructors + - ON + - Daily -- The **Notifications** tab on the **Account Settings** page. -- The gear icon in the top-right corner of the notification tray. -- The **Notification Settings** link in email. + * - 5 + - Updates + - Instructor created a course update + - Course updates + - ON + - Daily -For each preference: + * - 6 + - Grading + - You received a grade on your essay submission + - ORA grade received + - ON + - Daily -- Users can toggle tray and email preferences ON or OFF. -- Users can set the cadence for email notifications: Immediately, Daily, or Weekly. -.. image:: /_images/learners/Preference_center_learner.png - :width: 700 - :align: center - :alt: Screenshot of the preferences center on Account Settings. +.. _managing-preferences: -Default Settings ----------------- +Managing Preferences +==================== -- High-value notifications have tray and email ON by default. +.. figure:: /_images/learners/Notifications_preference_learner.png + :alt: Screenshot of the preferences center on Account Settings page. + :width: 600 + :align: center - - “New posts from instructors” and “Course updates” are exceptions where email is OFF by default to prevent high email volume/cost for courses with large enrollments. + You can manage notification preference on *Account Settings* page. -- High-volume notifications (e.g., new discussion posts) are OFF by default to prevent clutter. -- The default email cadence is set to **Daily** for all preferences where email is ON by default. +Notification preferences allow you to control which notifications you receive, how often, and through +which channel. You can get to the preferences page via: -The table below shows defaults for each notification type. +- The Notifications section on the *Account Settings* page. +- The gear icon in the top-right corner of the notification tray. +- The *Notification Settings* link at the bottom of notifications in email. -.. list-table:: - :widths: 25 25 25 25 - :align: center - :header-rows: 1 +For each preference, you can: + +- Turn tray notifications on or off. +- Turn email notifications on or off. +- Choose an email cadence: Immediate, Daily, or Weekly - * - Preference - - Default Tray Preference - - Default Email Preference - - Visibility - * - Activity notifications - - ON - - ON / Daily - - All - * - New discussion posts - - OFF - - OFF - - All - * - New question qosts - - OFF - - OFF - - All - * - New posts from instructors - - ON - - ON - - All - * - Course updates - - ON - - OFF - - All - * - Essay assignment grade received - - ON - - ON / Daily - - All .. _notifications-expiry: Notifications Expiry ==================== -Every day, notifications older than 60 days are deleted from the database. \ No newline at end of file +Your site administrator may set a time limit for how long notifications remain available. +Once they reach that age, they are automatically removed from your notification tray. \ No newline at end of file diff --git a/source/site_ops/how-tos/add-waffle-flag-for-user.rst b/source/site_ops/how-tos/add-waffle-flag-for-user.rst index b2f66d2f3..ba2d60fb8 100644 --- a/source/site_ops/how-tos/add-waffle-flag-for-user.rst +++ b/source/site_ops/how-tos/add-waffle-flag-for-user.rst @@ -1,3 +1,5 @@ +.. _Enable a Waffle Flag for a User: + How to Enable a Waffle Flag for a User ####################################### diff --git a/source/site_ops/how-tos/google-analytics.rst b/source/site_ops/how-tos/google-analytics.rst index 514aba354..964e9c5dc 100644 --- a/source/site_ops/how-tos/google-analytics.rst +++ b/source/site_ops/how-tos/google-analytics.rst @@ -1,4 +1,6 @@ -Configuring Google Analytics +.. _Configure Google Analytics: + +Configure Google Analytics ############################ .. tags:: site operator, how-to diff --git a/source/site_ops/how-tos/use-frontend-plugin-slots.rst b/source/site_ops/how-tos/use-frontend-plugin-slots.rst index 9cb0998d9..d3f4266e5 100644 --- a/source/site_ops/how-tos/use-frontend-plugin-slots.rst +++ b/source/site_ops/how-tos/use-frontend-plugin-slots.rst @@ -1,3 +1,5 @@ +.. _Use A Frontend Plugin Framework Slot: + Use A Frontend Plugin Framework Slot #################################### diff --git a/source/site_ops/index.rst b/source/site_ops/index.rst index 7e23bfe94..f818fbba1 100644 --- a/source/site_ops/index.rst +++ b/source/site_ops/index.rst @@ -3,32 +3,68 @@ Open edX Site Operators .. tags:: site operator -.. note:: +.. grid:: 1 2 2 2 + :gutter: 3 + :padding: 0 - This area is still under active development. + .. grid-item-card:: More About Tutor + :class-card: sd-shadow-md sd-p-2 + :class-footer: sd-border-0 - For information about the latest release of the Open edX Platform, you can - check out the :doc:`/community/release_notes/index` + * :ref:`Tutor Concept (Operator)` + * :ref:`Tutor QS (Operator)` + + +++ + .. button-link:: https://docs.tutor.edly.io/ + :color: primary + :outline: + :expand: -************************** -Quick Links -************************** + Tutor Documentation (off-site) -.. toctree:: - :maxdepth: 1 - :glob: + .. grid-item-card:: What's New + :class-card: sd-shadow-md sd-p-2 + :class-footer: sd-border-0 + + * :ref:`Available Frontend Plugin Slots` + * :ref:`Badges Configuration examples` - install_configure_run_guide/index - quickstarts/index - how-tos/index - concepts/index - references/index + + .. grid-item-card:: Installing & Configuration Guide + :class-card: sd-shadow-md sd-p-2 + :class-footer: sd-border-0 + + + +++ + .. button-ref:: install_configure_run_guide/index + :color: primary + :outline: + :expand: + + Installing, Configuring, and Running the Open edX Platform + + .. grid-item-card:: How-To Guides + :class-card: sd-shadow-md sd-p-2 + :class-footer: sd-border-0 + + * :ref:`Use A Frontend Plugin Framework Slot` + * :ref:`Configure Google Analytics` + * :ref:`Enable a Waffle Flag for a User` + + +++ + .. button-ref:: how-tos/index + :color: primary + :outline: + :expand: + + More How-Tos ******************************* All Site Operators' Guides ******************************* .. toctree:: + :maxdepth: 1 :glob: install_configure_run_guide/index diff --git a/source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst b/source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst index fca82a3ac..c4e2839ab 100644 --- a/source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst +++ b/source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst @@ -170,6 +170,8 @@ organization. For example, you can change the images that appear on certificates for each course mode that your organization supports, as well as fonts and colors that are used on certificates. +To understand how to customize certificate templates in general, see :ref:`Certificates for Custom Cases`. + To issue certificates in more than one language, see :ref:`Certificates in Additional Languages`. @@ -192,42 +194,56 @@ Assets for HTML certificates exist in the following locations. and Running an Open edX Course*. +.. _Certificates for Custom Cases: -.. _Certificates in Additional Languages: +************************************************** +Customize Certificate Templates For Specific Cases +************************************************** -******************************************* -Enable Certificates in Additional Languages -******************************************* +You can customize a certificate template for a specifc course run, course, an +organization, a language, or a mode. -You can configure course certificates to render in a specific language. +The feature is enabled by setting the `CUSTOM_CERTIFICATE_TEMPLATES_ENABLED` +flag in the FEATURES dictionary of your settings: -.. contents:: - :local: - :depth: 1 +``FEATURES['CUSTOM_CERTIFICATE_TEMPLATES_ENABLED'] = True`` -===================================================== -Configure Course Certificates in Additional Languages -===================================================== +When choosing which template to render a certificate with we will choose the +most specific that applies to the situation. We will pick the first template +that matches the following criteria, in order: -To enable generating course certificates in languages other than the -default language of your platform, follow these steps. +#. A language-specific course run template. -.. note:: Base certificate templates already exist for English and - Spanish. If you want a course certificate that is different from the - default certificate for the organization or language, create a new - certificate template. +#. A course run template. -#. Add the language in which you want to generate certificates to - ``EDXAPP_CERTIFICATE_TEMPLATE_LANGUAGES`` - (``edx/configuration/playbooks/roles/edxapp/defaults/main.yml``), where the - key is the language code and the value is the name of the language. +#. A language-specific custom template defined at the `Organization` level. - For example, ``'fr':'français'``. +#. A custom template defined at the `Organization` level. + +#. The language-specific default template for the mode (Verified, Audit, etc.). + +#. The default template for the mode (Verified, Audit, etc.). + +#. The language-specific default certificate styling included for the instance. + +#. The default certificate styling included for the instance. + + +.. note:: If you have a language-specific template defined at a high level, and + you define a lower level template in your instance's default language, + that will override the language-specific template. In order to have + a language-specific template apply, you must define it at the same or + a lower level than any other templates that would apply to the course run. + +==================== +Create the Templates +==================== #. In the LMS Django Administration site for your instance of Open edX, under **Site Administration** > **Certificates** > **Certificate templates**, add - a certificate template for each additional language in which you want to - generate certificates. + a certificate template for each additional case for which you want to + generate certificates. (This will be `admin/certificates/certificatetemplate/` + on your instance.) #. In each certificate template, modify the configuration parameters as required to apply the template either to all course runs in an @@ -266,14 +282,42 @@ default language of your platform, follow these steps. - Select this checkbox to make this template active. - Select this checkbox to make this template active. +#. Save each certificate template. - .. note:: If more than one certificate template would apply to a course - run, the most specific (lowest level) template is used. For example, if - you define a certificate template for all courses in an organization and - another template for a specific course run, the template for the course - run is used. -#. Save each certificate template. +.. _Certificates in Additional Languages: + +******************************************* +Enable Certificates in Additional Languages +******************************************* + +You can configure course certificates to render in a specific language. + +.. contents:: + :local: + :depth: 1 + +===================================================== +Configure Course Certificates in Additional Languages +===================================================== + +To enable generating course certificates in languages other than the +default language of your platform, follow these steps. + +.. note:: Base certificate templates already exist for English and + Spanish. If you want a course certificate that is different from the + default certificate for the organization or language, create a new + certificate template. + +#. Add the language in which you want to generate certificates to + ``EDXAPP_CERTIFICATE_TEMPLATE_LANGUAGES`` + (``edx/configuration/playbooks/roles/edxapp/defaults/main.yml``), where the + key is the language code and the value is the name of the language. + + For example, ``'fr':'français'``. + +#. Follow the instructions in :ref:`Certificates for Custom Cases` to create a + certificate template for the language. #. ONLY if you are enabling additional language certificates for a specific course run, add a certificate generation course setting in LMS Django @@ -285,7 +329,6 @@ default language of your platform, follow these steps. #. Select **Language specific templates enabled**, and save the configuration. - .. _Display Hours of Effort: ********************************************** diff --git a/source/site_ops/install_configure_run_guide/configuration/enable_discussion_notifications.rst b/source/site_ops/install_configure_run_guide/configuration/enable_discussion_notifications.rst index 760e7aef8..630f4c598 100644 --- a/source/site_ops/install_configure_run_guide/configuration/enable_discussion_notifications.rst +++ b/source/site_ops/install_configure_run_guide/configuration/enable_discussion_notifications.rst @@ -10,8 +10,7 @@ You can set up notifications that learners receive the first time that anyone adds a response to a discussion post that they have made. For more information, including the text of the discussion notification -message, see :ref:`Automatic Emails` and -:ref:`Receiving Discussion Notifications`. +message, see :ref:`Automatic Emails` and :ref:`Staying Updated with Notifications`. .. contents:: :depth: 1 diff --git a/source/site_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst b/source/site_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst index e9a7f8e11..e0e34de7b 100644 --- a/source/site_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst +++ b/source/site_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst @@ -37,10 +37,10 @@ URLS, a link to the course About page in the LMS is used. Configure Social Sharing ******************************* -To enable social sharing icons for courses, you modify the ``lms.yml`` -file, which is located one level above the ``edx-platform`` directory. +To enable social sharing icons for courses, you modify the ``lms/envs/common.py`` +on ``edx-platform`` directory. -#. In the ``lms.yml`` file, modify the ``SOCIAL_SHARING_SETTINGS`` +#. In the ``lms/envs/common.py`` file, modify the ``SOCIAL_SHARING_SETTINGS`` dictionary as needed. .. code-block:: none @@ -69,7 +69,7 @@ file, which is located one level above the ``edx-platform`` directory. c. If you set ``CUSTOM_COURSE_URLS`` to ``True``, you must `Enable Custom Course URLs`_. -#. Configure the ``SOCIAL_MEDIA_FOOTER_NAMES`` array in the ``lms.yml`` +#. Configure the ``SOCIAL_MEDIA_FOOTER_NAMES`` array in the ``lms/envs/common.py`` file to set the order of links you want learners to see in the footer. .. code-block:: none @@ -84,7 +84,7 @@ file, which is located one level above the ``edx-platform`` directory. ] #. Configure the ``SOCIAL_MEDIA_FOOTER_DISPLAY`` dictionary in the - ``lms.yml`` file to define how you want social media icons to be + ``lms/envs/common.py`` file to define how you want social media icons to be displayed. For each social media icon you enable, you define a ``title``, ``icon``, and ``action``. @@ -107,7 +107,35 @@ file, which is located one level above the ``edx-platform`` directory. } } -#. Save the ``lms.yml`` file. +#. Save the ``lms/envs/common.py`` file. + +================================================ +Enable Certificate Sharing to LinkedIn +================================================ +This guide explains how to configure the platform to allow learners to share their certificates directly to their LinkedIn profiles. + +To activate the **"Add Certificate to LinkedIn"** button for learners, set the following configuration value to ``True`` on ``lms/envs/common.py``: + + .. code-block:: none + + 'CERTIFICATE_LINKEDIN': True + +The organization name displayed on the shared certificate is determined by the following settings, in order of priority: + +#. Course-Specific Organization: To use the organization name defined for each individual course, enable this setting: + + .. code-block:: none + + 'CERTIFICATE_LINKEDIN_DEFAULTS_TO_COURSE_ORGANIZATION_NAME': True + +#. Platform-Wide Company ID: To use a single, platform-wide company ID (found in your LinkedIn Company Page settings), configure this value: + + .. code-block:: none + + 'LINKEDIN_COMPANY_ID': '133-TEST-ID' + +#. Platform Name Fallback: If neither of the above is configured, the platform's general name will be used as the organization name. + ***************************************** Enable Custom Course URLs diff --git a/source/site_ops/install_configure_run_guide/index.rst b/source/site_ops/install_configure_run_guide/index.rst index be982a205..d22bce144 100755 --- a/source/site_ops/install_configure_run_guide/index.rst +++ b/source/site_ops/install_configure_run_guide/index.rst @@ -4,23 +4,23 @@ Installing, Configuring, and Running the Open edX Platform ########################################################### -.. tags:: site operator +.. tags:: site operator, reference This guide provides instructions for using your own instance of the Open edX platform and associated applications. -The most recent Open edX release will be found on the :ref:`Open edX Release Notes`. -It is strongly recommended to use `Tutor`_ for both development and installation. -It is also recommended to stay up-to-date with the latest Open edX release, as -previous releases are unsupported by the community. See the `Open edX Release Schedule`_ -for information on release dates and end-of-life support. +The most recent Open edX release will be found on the :ref:`Open edX Release +Notes`. It is strongly recommended to use `Tutor`_ (see :ref:`Tutor Concept +(Operator)`) for both development and installation. It is also recommended to +stay up-to-date with the latest Open edX release, as previous releases are +unsupported by the community. See the `Open edX Release Schedule`_ for +information on release dates and end-of-life support. You *can* install any release of the Open edX platform, but note the community will likely be unable to answer questions about issues you encounter. Please be aware that older releases do not receive security fixes or any of the latest features, and documentation on docs.openedx.org will always reflect the latest release. -release. .. toctree:: :maxdepth: 2 diff --git a/source/site_ops/references/frontend-plugin-slots.rst b/source/site_ops/references/frontend-plugin-slots.rst index 735fcd9a6..b9e02f220 100644 --- a/source/site_ops/references/frontend-plugin-slots.rst +++ b/source/site_ops/references/frontend-plugin-slots.rst @@ -88,6 +88,11 @@ Slots only available in the Learning MFE: - `org.openedx.frontend.learning.sequence_container.v1 `_ - `org.openedx.frontend.learning.unit_title.v1 `_ +Special exams slots, available in MFEs that use ``frontend-lib-special-exams``: +******************************************************************************* + +- `org.openedx.frontend.special_exams.submitted_timed_exam_instructions.v1 `_ + .. seealso:: * :doc:`/site_ops/how-tos/use-frontend-plugin-slots` diff --git a/source/translators/how-tos/how-to-fix-translation-errors.rst b/source/translators/how-tos/how-to-fix-translation-errors.rst index fb84df93d..6d7d3c8bd 100644 --- a/source/translators/how-tos/how-to-fix-translation-errors.rst +++ b/source/translators/how-tos/how-to-fix-translation-errors.rst @@ -1,7 +1,9 @@ +.. _How to fix translation validation errors: + How to fix translation validation errors ######################################## -As part of OEP-58 (:doc:`/developers/concepts/oep58`), automatic translation validation has been added to avoid +As part of OEP-58 (:ref:`OEP-58 Overview`), automatic translation validation has been added to avoid breaking builds and deployments due to invalid translations. As of writing this document, `validation scripts and GitHub Actions`_ checks .po files for compilation errors. diff --git a/source/translators/how-tos/how-to-join-a-review-team.rst b/source/translators/how-tos/how-to-join-a-review-team.rst index ea692972c..37e206f43 100644 --- a/source/translators/how-tos/how-to-join-a-review-team.rst +++ b/source/translators/how-tos/how-to-join-a-review-team.rst @@ -31,7 +31,7 @@ To join a review team, request permission from the project coordinator(s): project page. You can also obtain reviewer and coordinator access by contacting the - Translation Working Group’s Organizer via ``ehuthmacher at axim dot org``. + Translation Working Group's Organizer via ``oscm at axim dot org``. **Maintenance chart** diff --git a/source/translators/how-tos/how-to-join-a-translation-team.rst b/source/translators/how-tos/how-to-join-a-translation-team.rst index fbfe06bf5..e7f64e8f6 100644 --- a/source/translators/how-tos/how-to-join-a-translation-team.rst +++ b/source/translators/how-tos/how-to-join-a-translation-team.rst @@ -5,7 +5,7 @@ In order to help translate Open edX projects, you must first join a translation for the language you wish to translate to. We use `Transifex`_ to allow our community to collaborate on translations. More detailed instructions for how to get involved in translations are located in the -:doc:`/translators/quickstarts/start-translating-openedx` page. +:ref:`How to start translating for Open edX` page. Steps ***** @@ -20,7 +20,7 @@ To join a translation team you must complete these steps: #. Join the Transifex `openedx-translations project`_ with the language(s) you wish to translate to. Please be proficient in both English and the language you wish to translate to! If that language does not yet exist, you may follow the directions - in :doc:`/translators/how-tos/how-to-request-a-new-language` to add it. + in :ref:`How to request a new language for translation` to add it. #. Join the Open edX Slack or Discuss. Links to join are available at the `Open edX Community`_ page. Translation help is available in the diff --git a/source/translators/how-tos/how-to-request-a-new-language.rst b/source/translators/how-tos/how-to-request-a-new-language.rst index 3110e3eeb..25e1c7b1d 100644 --- a/source/translators/how-tos/how-to-request-a-new-language.rst +++ b/source/translators/how-tos/how-to-request-a-new-language.rst @@ -1,3 +1,5 @@ +.. _How to request a new language for translation: + How to request a new language for translation ############################################# @@ -10,38 +12,52 @@ Assumptions * A variant of the language that may meet your needs is also not listed (``Chinese`` vs ``Chinese-China``). -* Prefer a root locale over a variant locale (``de`` over ``de_DE``) whenever applicable so other locales can inherit - from it e.g. ``de_AT``. +* Prefer a root locale over a variant locale (``de`` over ``de_DE``) whenever + applicable so other locales can inherit from it e.g. ``de_AT``. * If you request a new language, we ask that you commit to the success of your - language’s translation project. Particularly, we expect you to: + language's translation project. Particularly, we expect you to: - * Be an active translator: Translate the ``edx-platform``, ``edx-platform-js`` and main micro-frontends such as - Learning MFE and other resources in the `openedx-translations Transifex project`_ + * Be an active translator: Translate the ``edx-platform``, ``edx-platform-js`` + and main micro-frontends such as Learning MFE and other resources in the + `openedx-translations Transifex project`_. - * Work to recruit other translators and reviewers + * Work to recruit other translators and reviewers. * Monitor and address Transifex issues posted by translators. - * Monitor and fix translations validation errors: :doc:`how-to-fix-translation-errors`. + * Monitor and fix translations validation errors: :ref:`How to fix translation + validation errors`. You will be responsible for advancing your target language to completion, with all strings translated and reviewed, so that we can publish your work to the Open edX community. -.. note:: - Languages can be removed from the project if they are not actively maintained. +.. warning:: + + Languages can be removed from the project if they are not actively + maintained. Steps ***** -#. Go to the `openedx-translations Transifex project`_ +#. Email ``oscm@axim.org`` to request a new language code. Please do *not* + request a language from the `openedx-translations Transifex project`_, + because we can't communicate with you via this channel. Please email instead. + +#. Wait for an Open edX translation team member to respond to your request + within a few days. Please keep the following in mind: -#. Select the option :guilabel:`Request language` to start a new translation - project for your target language. + * The Open edX team needs to verify the language code and often will have + questions before accepting a new language. For example, a request for a + specific locale (such as German for Germany ``de_DE`` or Arabic for Iraq ``ar_IQ``) will be weighed + against a more global language code (such as global German ``de`` or global Arabic ``ar``). -#. Wait for an edX translation team member to - respond to your request within a few days. + * A language will only be added with a commitment from an individual or group + to manage the translators for the language for at least one release. The + Open edX project is large, and there's high turnaround of translators which + often results in low quality translations and in some cases invalid translations + that cause server errors. #. If the language that you request is approved, you become the coordinator of the project. You can add @@ -52,8 +68,8 @@ Steps **Maintenance chart** -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ +| 2025-10-03 | Omar | No release | Pass | ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ diff --git a/source/translators/quickstarts/start-translating-openedx.rst b/source/translators/quickstarts/start-translating-openedx.rst index 9367c4b1e..9b4cc4c69 100644 --- a/source/translators/quickstarts/start-translating-openedx.rst +++ b/source/translators/quickstarts/start-translating-openedx.rst @@ -1,3 +1,5 @@ +.. _How to start translating for Open edX: + Quick Start: How to start translating for Open edX ##################################################