From 1e3074a3f9b40aab3543ee3337d733b9022138c6 Mon Sep 17 00:00:00 2001 From: sarina Date: Sat, 29 Mar 2025 11:16:20 -0400 Subject: [PATCH] docs: Update edx.rtd.io links to docs.openedx.org --- CHANGELOG.rst | 4 +-- cms/README.rst | 2 +- cms/envs/common.py | 24 +++++++------- ...xblock-component-support-legend.underscore | 2 +- common/djangoapps/third_party_auth/README.rst | 2 +- common/djangoapps/track/README.rst | 2 +- .../test/data/scoreable/about/overview.html | 2 +- docs/concepts/extension_points.rst | 18 +++++------ docs/decisions/0001-courses-in-lms.rst | 4 +-- .../docs/decisions/003-web-certs.rst | 4 +-- lms/djangoapps/grades/docs/background.rst | 18 +++++------ lms/djangoapps/ora_staff_grader/views.py | 2 +- lms/envs/common.py | 31 +++++++++---------- lms/static/js/fixtures/calculator.html | 4 +-- .../calculator/toggle_calculator.html | 6 ++-- .../_edx-accomplishment-print-help.html | 2 +- .../core/djangoapps/schedules/docs/README.rst | 4 +-- openedx/core/djangoapps/user_api/README.rst | 2 +- .../logging-and-monitoring-ignored-errors.rst | 2 +- openedx/features/course_bookmarks/README.rst | 2 +- openedx/features/course_search/README.rst | 2 +- scripts/xsslint/xss_linter.py | 2 +- test_root/semgrep/celery-code-owner.yml | 6 ++-- themes/README.rst | 2 +- themes/open-edx/README.rst | 4 ++- themes/open-edx/cms/README.rst | 4 ++- themes/open-edx/lms/README.rst | 4 ++- xmodule/course_block.py | 4 +-- xmodule/lti_block.py | 2 +- xmodule/templates/about/overview.yaml | 2 +- .../templates/problem/circuitschematic.yaml | 4 +-- xmodule/templates/problem/customgrader.yaml | 4 +-- xmodule/templates/problem/drag_and_drop.yaml | 4 +-- xmodule/templates/problem/imageresponse.yaml | 4 +-- .../templates/problem/jsinput_response.yaml | 9 ++---- xmodule/templates/problem/latex_problem.yaml | 4 +-- 36 files changed, 99 insertions(+), 99 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 0a25729d5c..0658b92b2e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,8 +1,8 @@ We don't maintain a detailed changelog. For details of changes, please see -either the `edX Release Notes`_ or the `GitHub commit history`_. +either the `Open edX Release Notes`_ or the `GitHub commit history`_. -.. _edX Release Notes: https://edx.readthedocs.io/projects/open-edx-release-notes/en/latest/ +.. _Open edX Release Notes: https://docs.openedx.org/en/latest/community/release_notes/index.html .. _GitHub commit history: https://github.com/openedx/edx-platform/commits/master diff --git a/cms/README.rst b/cms/README.rst index ee96c5cf09..27aa819a14 100644 --- a/cms/README.rst +++ b/cms/README.rst @@ -1,7 +1,7 @@ CMS === -This directory contains code relating to the Open edX Content Management System ("CMS"). It allows learning content to be created, edited, versioned, and eventually published to the `Open edX Learning Mangement System <../lms>`_ ("LMS"). The main user-facing application that CMS powers is the `Open edX Studio `_ +This directory contains code relating to the Open edX Content Management System ("CMS"). It allows learning content to be created, edited, versioned, and eventually published to the `Open edX Learning Mangement System <../lms>`_ ("LMS"). The main user-facing application that CMS powers is the `Open edX Studio `_ See also -------- diff --git a/cms/envs/common.py b/cms/envs/common.py index 5d4dea7c23..6cc1938271 100644 --- a/cms/envs/common.py +++ b/cms/envs/common.py @@ -2779,16 +2779,16 @@ SHOW_ACCOUNT_ACTIVATION_CTA = False ################# Documentation links for course apps ################# # pylint: disable=line-too-long -CALCULATOR_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/exercises_tools/calculator.html" -DISCUSSIONS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_components/create_discussion.html" -EDXNOTES_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/exercises_tools/notes.html" -PROGRESS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html?highlight=progress#hiding-or-showing-the-wiki-or-progress-pages" -TEAMS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_features/teams/teams_setup.html" -TEXTBOOKS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/textbooks.html" -WIKI_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/course_wiki.html" -CUSTOM_PAGES_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html#adding-custom-pages" -COURSE_LIVE_HELP_URL = "https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_assets/course_live.html" -ORA_SETTINGS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html#configuring-course-level-open-response-assessment-settings" +CALCULATOR_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/add_calculator.html" +DISCUSSIONS_HELP_URL = "https://docs.openedx.org/en/latest/educators/concepts/communication/about_course_discussions.html" +EDXNOTES_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/enable_notes.html" +PROGRESS_HELP_URL = "https://docs.openedx.org/en/latest/educators/references/data/progress_page.html" +TEAMS_HELP_URL = "https://docs.openedx.org/en/latest/educators/navigation/advanced_features.html#use-teams-in-your-course" +TEXTBOOKS_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_textbooks.html" +WIKI_HELP_URL = "https://docs.openedx.org/en/latest/educators/concepts/communication/about_course_wiki.html" +CUSTOM_PAGES_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_custom_page.html" +COURSE_LIVE_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/add_course_live.html" +ORA_SETTINGS_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.html" # pylint: enable=line-too-long # keys for big blue button live provider @@ -2813,7 +2813,7 @@ DISCUSSIONS_INCONTEXT_FEEDBACK_URL = '' # Learn More link in upgraded discussion notification alert # pylint: disable=line-too-long -DISCUSSIONS_INCONTEXT_LEARNMORE_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/manage_discussions/discussions.html" +DISCUSSIONS_INCONTEXT_LEARNMORE_URL = "https://docs.openedx.org/en/latest/educators/concepts/communication/about_course_discussions.html" # pylint: enable=line-too-long #### django-simple-history## @@ -2837,7 +2837,7 @@ def _should_send_learning_badge_events(settings): # Each topic configuration dictionary contains # * `enabled`: a toggle denoting whether the event will be published to the topic. These should be annotated # according to -# https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html +# https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html # * `event_key_field` which is a period-delimited string path to event data field to use as event key. # Note: The topic names should not include environment prefix as it will be dynamically added based on # EVENT_BUS_TOPIC_PREFIX setting. diff --git a/cms/templates/js/add-xblock-component-support-legend.underscore b/cms/templates/js/add-xblock-component-support-legend.underscore index 483e786581..1e15448563 100644 --- a/cms/templates/js/add-xblock-component-support-legend.underscore +++ b/cms/templates/js/add-xblock-component-support-legend.underscore @@ -1,7 +1,7 @@ <% if (support_legend.show_legend) { %> + href="https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/guide_problem_types.html" rel="noopener" target="_blank"> <%- support_legend.documentation_label %> diff --git a/common/djangoapps/third_party_auth/README.rst b/common/djangoapps/third_party_auth/README.rst index d2e1089eca..eae19bc79b 100644 --- a/common/djangoapps/third_party_auth/README.rst +++ b/common/djangoapps/third_party_auth/README.rst @@ -8,4 +8,4 @@ We make use of the `social-auth-app-django`_ as our backend library for this dja To enable this feature, check out the `third party authentication documentation`. .. _social-auth-app-django: https://github.com/python-social-auth/social-app-django -.. _third party authentication documentation: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/tpa/index.html +.. _third party authentication documentation: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/tpa/index.html diff --git a/common/djangoapps/track/README.rst b/common/djangoapps/track/README.rst index 3472048286..80a62a2318 100644 --- a/common/djangoapps/track/README.rst +++ b/common/djangoapps/track/README.rst @@ -12,4 +12,4 @@ Glossary More Documentation ================== -`Events in the Tracking Logs `_ +`Events in the Tracking Logs `_ diff --git a/common/test/data/scoreable/about/overview.html b/common/test/data/scoreable/about/overview.html index d554b6a018..4c4e94bb9f 100644 --- a/common/test/data/scoreable/about/overview.html +++ b/common/test/data/scoreable/about/overview.html @@ -37,7 +37,7 @@

What web browser should I use?

The Open edX platform works best with current versions of Chrome, Firefox or Safari, or with Internet Explorer version 9 and above.

-

See our list of supported browsers for the most up-to-date information.

+

See our list of supported browsers for the most up-to-date information.

diff --git a/docs/concepts/extension_points.rst b/docs/concepts/extension_points.rst index 3136aa8057..ac70edc432 100644 --- a/docs/concepts/extension_points.rst +++ b/docs/concepts/extension_points.rst @@ -69,12 +69,12 @@ If you want to provide learners with new content experiences within courses, opt For a more detailed comparison of content integration options, see `Options for Extending the edX Platform`_ in the *Open edX Developer's Guide*. -.. _XBlock tutorial: https://edx.readthedocs.io/projects/xblock-tutorial/en/latest/ -.. _as a consumer: https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/lti_component.html -.. _as a provider: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/lti/ -.. _Options for Extending the edX Platform: https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/extending.html -.. _custom JavaScript application: https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/javascript.html -.. _external grader documentation: https://edx.readthedocs.io/projects/open-edx-ca/en/latest/exercises_tools/external_graders.html +.. _XBlock tutorial: https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/index.html +.. _as a consumer: https://docs.openedx.org/en/latest/educators/navigation/components_activities.html#lti-component +.. _as a provider: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/lti/index.html +.. _Options for Extending the edX Platform: https://docs.openedx.org/en/latest/developers/references/developer_guide/extending_platform/extending.html +.. _custom JavaScript application: https://docs.openedx.org/en/latest/educators/references/course_development/exercise_tools/custom_javascript.html +.. _external grader documentation: https://docs.openedx.org/en/latest/educators/concepts/exercise_tools/about_external_graders.html .. _You can follow this guide to install and enable custom TinyMCE plugins: extensions/tinymce_plugins.rst @@ -150,7 +150,7 @@ Here are the different integration points that python plugins can use: .. _course tabs documentation: https://openedx.atlassian.net/wiki/spaces/AC/pages/30965919/Adding+a+new+course+tab .. |course_tools.py| replace:: ``course_tools.py`` .. _course_tools.py: https://github.com/openedx/edx-platform/blob/master/openedx/features/course_experience/course_tools.py -.. _Adding Custom Fields to the Registration Page: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/customize_registration_page.html +.. _Adding Custom Fields to the Registration Page: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/customize_registration_page.html .. |learning_context.py| replace:: ``learning_context.py`` .. _learning_context.py: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/xblock/learning_context/learning_context.py .. |UserPartition docstring| replace:: ``UserPartition`` docstring @@ -189,8 +189,8 @@ In addition, Open edX operators will be able to replace entire MFEs with complet .. |example edx theme| replace:: example ``edx`` theme .. _example edx theme: https://github.com/openedx/paragon/tree/master/scss/edx -.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/ -.. _Overriding Brand Specific Elements: https://edx.readthedocs.io/projects/edx-developer-docs/en/latest/developers_guide/micro_frontends_in_open_edx.html#overriding-brand-specific-elements +.. _Changing Themes for an Open edX Site: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/index.html +.. _Overriding Brand Specific Elements: https://github.com/openedx/brand-openedx Custom frontends **************** diff --git a/docs/decisions/0001-courses-in-lms.rst b/docs/decisions/0001-courses-in-lms.rst index f4f931aaa0..3c191a464e 100644 --- a/docs/decisions/0001-courses-in-lms.rst +++ b/docs/decisions/0001-courses-in-lms.rst @@ -21,8 +21,8 @@ In the LMS, the following technologies can be used to access course content and .. _edX DDD Ubiquitous Language: https://openedx.atlassian.net/wiki/spaces/AC/pages/188032048/edX+DDD+Ubiquitous+Language .. _Course Overviews: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/content/course_overviews/__init__.py -.. _Course Blocks: https://openedx.atlassian.net/wiki/display/EDUCATOR/Course+Blocks -.. _Modulestore: https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/modulestores/index.html +.. _Course Blocks: https://openedx.atlassian.net/wiki/spaces/AC/pages/158321366/Course+Blocks+aka+xblocks+components +.. _Modulestore: https://docs.openedx.org/projects/edx-platform/en/latest/references/docs/xmodule/modulestore/docs/overview.html Decisions ========= diff --git a/lms/djangoapps/certificates/docs/decisions/003-web-certs.rst b/lms/djangoapps/certificates/docs/decisions/003-web-certs.rst index 191a8d1d88..fd3112580f 100644 --- a/lms/djangoapps/certificates/docs/decisions/003-web-certs.rst +++ b/lms/djangoapps/certificates/docs/decisions/003-web-certs.rst @@ -117,9 +117,9 @@ Related DEPR (edX deprecation process) tickets: * `Remove PDF generation code`_ * `Remove PDF view code`_ -.. _Enable Course Certificates: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_certificates.html +.. _Enable Course Certificates: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/enable_certificates.html .. _Deprecate web certificate setting: https://github.com/openedx/edx-platform/pull/17285 .. _Disable PDF certificate generation: https://github.com/openedx/edx-platform/pull/19833 -.. _Set Up Certificates in Studio: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/set_up_course/studio_add_course_information/studio_creating_certificates.html +.. _Set Up Certificates in Studio: https://docs.openedx.org/en/latest/educators/how-tos/set_up_course/manage_certificates.html .. _Remove PDF generation code: https://openedx.atlassian.net/browse/DEPR-155 .. _Remove PDF view code: https://openedx.atlassian.net/browse/DEPR-157 diff --git a/lms/djangoapps/grades/docs/background.rst b/lms/djangoapps/grades/docs/background.rst index ef10145538..0db97fc5ed 100644 --- a/lms/djangoapps/grades/docs/background.rst +++ b/lms/djangoapps/grades/docs/background.rst @@ -79,13 +79,13 @@ Overall Course Grade - A learner's overall numerical grade in the course can range anywhere between 0% to 100%. - - Course teams set the `grade range `_ and specify the Pass / Fail threshold (for example, a minimum of 50/100 is required to Pass). + - Course teams set the `grade range `_ and specify the Pass / Fail threshold (for example, a minimum of 50/100 is required to Pass). - The Passing grade range can be further divided into letter grades, such as A, B, etc. Assignment Weights -* Course teams set the `assignment types `_ used in the course, along with their weights and the number of allowed drops (number of assignments with the lowest grades that can be discarded in the final grade computation). +* Course teams set the `assignment types `_ used in the course, along with their weights and the number of allowed drops (number of assignments with the lowest grades that can be discarded in the final grade computation). Computation @@ -118,9 +118,9 @@ Problem Scores - **automatically scored, synchronously** at the time of submission, such as for most Capa-based problems - - **automatically scored, asynchronously** via an `external grader service `_ + - **automatically scored, asynchronously** via an `external grader service `_ - - **manually scored**, such as for `Open Response Assessments `_, where the calculation requires human input from either + - **manually scored**, such as for `Open Response Assessments `_, where the calculation requires human input from either - a single course staff (staff assessment) @@ -153,19 +153,19 @@ As described above in the Grade Computation section, the grading policy is distr - A problem's external grader configuration - - A problem's individual grading policy - as currently supported by `ORA's assessment configuration `_ + - A problem's individual grading policy - as currently supported by `ORA's assessment configuration `_ Grade Overrides/Exceptions -------------------------- -Today, we support the following features to `adjust grades `_, but don't have a general feature to override a grade for any xBlock: +Today, we support the following features to `adjust grades `_, but don't have a general feature to override a grade for any xBlock: -* In `ORA Studio settings `_: +* In `ORA Studio settings `_: - override a learner's grade for an ORA2 block -* In LMS Instructor Dashboard or `Staff Debug Info `_: +* In LMS Instructor Dashboard or `Staff Debug Info `_: - reset the number of attempts a learner has made for a problem back to 0 @@ -173,7 +173,7 @@ Today, we support the following features to `adjust grades `_: +* In `Gradebook `_: - override a subsection grade for a learner - override subsection grades in bulk (master's track only) diff --git a/lms/djangoapps/ora_staff_grader/views.py b/lms/djangoapps/ora_staff_grader/views.py index 16c84ca27a..50a1e03196 100644 --- a/lms/djangoapps/ora_staff_grader/views.py +++ b/lms/djangoapps/ora_staff_grader/views.py @@ -105,7 +105,7 @@ class InitializeView(StaffGraderBaseView): # This toggle is documented on the edx-ora2 repo in openassessment/xblock/config_mixin.py # Note: Do not copy this practice of directly using a toggle from a library. # Instead, see docs for exposing a wrapper api: - # https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/implement_the_right_toggle_type.html#using-other-toggles pylint: disable=line-too-long + # https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/implement_the_right_toggle_type.html#using-other-toggles pylint: disable=line-too-long # pylint: disable=toggle-missing-annotation enhanced_staff_grader_flag = CourseWaffleFlag( f"{WAFFLE_NAMESPACE}.{ENHANCED_STAFF_GRADER}", diff --git a/lms/envs/common.py b/lms/envs/common.py index 6b9d516eeb..316dad98da 100644 --- a/lms/envs/common.py +++ b/lms/envs/common.py @@ -320,7 +320,7 @@ FEATURES = { # .. toggle_default: False # .. toggle_description: Set to True to enable Custom Courses for edX, a feature that is more commonly known as # CCX. Documentation for configuring and using this feature is available at - # https://edx.readthedocs.io/projects/open-edx-ca/en/latest/set_up_course/custom_courses.html + # https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/enable_ccx.html # .. toggle_warning: When set to true, 'lms.djangoapps.ccx.overrides.CustomCoursesForEdxOverrideProvider' will # be added to MODULESTORE_FIELD_OVERRIDE_PROVIDERS # .. toggle_use_cases: opt_in, circuit_breaker @@ -633,7 +633,7 @@ FEATURES = { # .. toggle_description: Set to True to enable course certificates on your instance of Open edX. # .. toggle_warning: You must enable this feature flag in both Studio and the LMS and complete the configuration tasks # described here: - # https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/enable_certificates.html pylint: disable=line-too-long,useless-suppression + # https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/enable_certificates.html pylint: disable=line-too-long,useless-suppression # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-03-13 # .. toggle_target_removal_date: None @@ -706,7 +706,7 @@ FEATURES = { # and applications. # .. toggle_warning: After enabling this feature flag there are multiple steps involved to configure edX # as LTI provider. Full guide is available here: - # https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/lti/index.html + # https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/lti/index.html # .. toggle_use_cases: open_edx # .. toggle_creation_date: 2015-04-24 # .. toggle_tickets: https://github.com/openedx/edx-platform/pull/7689 @@ -2055,8 +2055,7 @@ LOCALE_PATHS = Derived(_make_locale_paths) MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage' # Guidelines for translators -TRANSLATORS_GUIDE = 'https://edx.readthedocs.org/projects/edx-developer-guide/en/latest/' \ - 'conventions/internationalization/i18n_translators_guide.html' +TRANSLATORS_GUIDE = 'https://docs.openedx.org/en/latest/translators/index.html' #################################### AWS ####################################### # The number of seconds that a generated URL is valid for. @@ -5257,16 +5256,16 @@ SHOW_ACCOUNT_ACTIVATION_CTA = False ################# Documentation links for course apps ################# # pylint: disable=line-too-long -CALCULATOR_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/exercises_tools/calculator.html" -DISCUSSIONS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_components/create_discussion.html" -EDXNOTES_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/exercises_tools/notes.html" -PROGRESS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html?highlight=progress#hiding-or-showing-the-wiki-or-progress-pages" -TEAMS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_features/teams/teams_setup.html" -TEXTBOOKS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/textbooks.html" -WIKI_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/course_wiki.html" -CUSTOM_PAGES_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html#adding-custom-pages" -COURSE_BULK_EMAIL_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/manage_live_course/bulk_email.html" -ORA_SETTINGS_HELP_URL = "https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/pages.html#configuring-course-level-open-response-assessment-settings" +CALCULATOR_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/add_calculator.html" +DISCUSSIONS_HELP_URL = "https://docs.openedx.org/en/latest/educators/concepts/communication/about_course_discussions.html" +EDXNOTES_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/enable_notes.html" +PROGRESS_HELP_URL = "https://docs.openedx.org/en/latest/educators/references/data/progress_page.html" +TEAMS_HELP_URL = "https://docs.openedx.org/en/latest/educators/navigation/advanced_features.html#use-teams-in-your-course" +TEXTBOOKS_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_textbooks.html" +WIKI_HELP_URL = "https://docs.openedx.org/en/latest/educators/concepts/communication/about_course_wiki.html" +CUSTOM_PAGES_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_custom_page.html" +COURSE_BULK_EMAIL_HELP_URL = "https://docs.openedx.org/en/latest/educators/references/communication/bulk_email.html" +ORA_SETTINGS_HELP_URL = "https://docs.openedx.org/en/latest/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.html" ################# Bulk Course Email Settings ################# # If set, recipients of bulk course email messages will be filtered based on the last_login date of their User account. @@ -5425,7 +5424,7 @@ def _should_send_learning_badge_events(settings): # Each topic configuration dictionary contains # * `enabled`: a toggle denoting whether the event will be published to the topic. These should be annotated # according to -# https://edx.readthedocs.io/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html +# https://docs.openedx.org/projects/edx-toggles/en/latest/how_to/documenting_new_feature_toggles.html # * `event_key_field` which is a period-delimited string path to event data field to use as event key. # Note: The topic names should not include environment prefix as it will be dynamically added based on # EVENT_BUS_TOPIC_PREFIX setting. diff --git a/lms/static/js/fixtures/calculator.html b/lms/static/js/fixtures/calculator.html index 2a6f189590..2bbff75422 100644 --- a/lms/static/js/fixtures/calculator.html +++ b/lms/static/js/fixtures/calculator.html @@ -13,8 +13,8 @@

  • For detailed information, see - Entering Mathematical and Scientific Expressions in the - EdX Learner's Guide. + Entering Mathematical and Scientific Expressions in the + Open edX Learner's Guide.

    • diff --git a/lms/templates/calculator/toggle_calculator.html b/lms/templates/calculator/toggle_calculator.html index d4a2401fee..b37d10fa3e 100644 --- a/lms/templates/calculator/toggle_calculator.html +++ b/lms/templates/calculator/toggle_calculator.html @@ -24,10 +24,10 @@ from openedx.core.djangolib.markup import HTML, Text

    ${_('Use the arrow keys to navigate the tips or use the tab key to return to the calculator')}

    - ${Text(_("For detailed information, see {math_link_start}Entering Mathematical and Scientific Expressions{math_link_end} in the {guide_link_start}edX Guide for Students{guide_link_end}.")).format( - math_link_start=HTML(''), + ${Text(_("For detailed information, see {math_link_start}Entering Mathematical and Scientific Expressions{math_link_end} in the {guide_link_start}Open edX Guide for Students{guide_link_end}.")).format( + math_link_start=HTML(''), math_link_end=HTML(''), - guide_link_start=HTML(''), + guide_link_start=HTML(''), guide_link_end=HTML(''), )} diff --git a/lms/templates/certificates/_edx-accomplishment-print-help.html b/lms/templates/certificates/_edx-accomplishment-print-help.html index eae27d96b0..1e6a0d2279 100644 --- a/lms/templates/certificates/_edx-accomplishment-print-help.html +++ b/lms/templates/certificates/_edx-accomplishment-print-help.html @@ -8,7 +8,7 @@ from openedx.core.djangolib.markup import HTML, Text

    ${Text(_("For tips and tricks on printing your certificate, view the {link_start}Web Certificates help documentation{link_end}.")).format( - link_start=HTML(''), + link_start=HTML(''), link_end=HTML(''), )}

    diff --git a/openedx/core/djangoapps/schedules/docs/README.rst b/openedx/core/djangoapps/schedules/docs/README.rst index 4e9f02ca39..04982d8971 100644 --- a/openedx/core/djangoapps/schedules/docs/README.rst +++ b/openedx/core/djangoapps/schedules/docs/README.rst @@ -66,7 +66,7 @@ Glossary plan on removing this term from this app's code to avoid confusion. - **Section**: From our - `documentation `__, + `documentation `__, “A section is the topmost category in your course. A section can represent a time period in your course, a chapter, or another organizing principle. A section contains one or more subsections.” @@ -155,7 +155,7 @@ Configuring A.C.E. These instructions assume you have already setup an Open edX instance or are running devstack. See the `Open edX Developer’s -Guide `__ +Guide `__ for information on setting them up. The Schedule app relies on ACE. When live, ACE sends emails to users diff --git a/openedx/core/djangoapps/user_api/README.rst b/openedx/core/djangoapps/user_api/README.rst index 9e5508ff14..d38f47175e 100644 --- a/openedx/core/djangoapps/user_api/README.rst +++ b/openedx/core/djangoapps/user_api/README.rst @@ -51,4 +51,4 @@ An example request using *curl*, storing information in a field named ``occupati It is important to note that this data will not be returned as part of the User API until the system's Site Configuration has been updated. Details on how to update the Site Configuration can be found `here`_. -.. _here: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/retrieve_extended_profile_metadata.html +.. _here: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/retrieve_extended_profile_metadata.html diff --git a/openedx/core/lib/docs/how_tos/logging-and-monitoring-ignored-errors.rst b/openedx/core/lib/docs/how_tos/logging-and-monitoring-ignored-errors.rst index 8305af4617..28e357e9e4 100644 --- a/openedx/core/lib/docs/how_tos/logging-and-monitoring-ignored-errors.rst +++ b/openedx/core/lib/docs/how_tos/logging-and-monitoring-ignored-errors.rst @@ -20,7 +20,7 @@ Additionally, a subset of ignored errors that are configured as ignored will als * Using New Relic terminology, this extra error class and message data will live on the Transaction and not the TransactionError, because ignored errors won't have a TransactionError. * Use these additional custom attributes to help diagnose unexpected issues with ignored errors. -.. _IGNORED_ERRORS settings and toggles on Readthedocs: https://edx.readthedocs.io/projects/edx-platform-technical/en/latest/search.html?q=IGNORED_ERRORS&check_keywords=yes&area=default +.. _IGNORED_ERRORS settings and toggles on Readthedocs: https://docs.openedx.org/projects/edx-platform/en/latest/search.html?q=IGNORED_ERRORS Logging ignored errors ----------------------- diff --git a/openedx/features/course_bookmarks/README.rst b/openedx/features/course_bookmarks/README.rst index 285e109341..774b3fd0e7 100644 --- a/openedx/features/course_bookmarks/README.rst +++ b/openedx/features/course_bookmarks/README.rst @@ -6,4 +6,4 @@ for a user to see all of their course bookmarks. It also registers a course tool called "Bookmarks" that provides a link to this page. For more information about the feature, see `Bookmarking Course Content`_. -.. _Bookmarking Course Content: https://edx.readthedocs.io/projects/open-edx-learner-guide/en/latest/SFD_bookmarks.html +.. _Bookmarking Course Content: https://docs.openedx.org/en/latest/learners/SFD_bookmarks.html diff --git a/openedx/features/course_search/README.rst b/openedx/features/course_search/README.rst index c6925c2967..8d6e394c3e 100644 --- a/openedx/features/course_search/README.rst +++ b/openedx/features/course_search/README.rst @@ -4,4 +4,4 @@ Course Search This directory contains a Django application that allows a learner to search the content of their course. To learn more, see `Enabling Open edX Search`_. -.. _Enabling Open edX Search: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/edx_search.html +.. _Enabling Open edX Search: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/edx_search.html diff --git a/scripts/xsslint/xss_linter.py b/scripts/xsslint/xss_linter.py index b32c54aa5c..76de199f09 100755 --- a/scripts/xsslint/xss_linter.py +++ b/scripts/xsslint/xss_linter.py @@ -258,7 +258,7 @@ def main(): epilog += "understand and fix any violations, read the docs here:\n" epilog += "\n" # pylint: disable=line-too-long - epilog += " https://edx.readthedocs.org/projects/edx-developer-guide/en/latest/conventions/preventing_xss.html#xss-linter\n" + epilog += " https://docs.openedx.org/en/latest/developers/references/developer_guide/preventing_xss/preventing_xss.html#xss-linter\n" parser = argparse.ArgumentParser( formatter_class=argparse.RawDescriptionHelpFormatter, diff --git a/test_root/semgrep/celery-code-owner.yml b/test_root/semgrep/celery-code-owner.yml index c8cf417e43..a1693752d2 100644 --- a/test_root/semgrep/celery-code-owner.yml +++ b/test_root/semgrep/celery-code-owner.yml @@ -5,7 +5,7 @@ rules: # https://github.com/returntocorp/semgrep/issues/8608 # # Here's the intended URL, for reference: - # https://edx.readthedocs.io/projects/edx-django-utils/en/latest/monitoring/how_tos/add_code_owner_custom_attribute_to_an_ida.html#handling-celery-tasks + # https://docs.openedx.org/projects/edx-django-utils/en/latest/monitoring/how_tos/add_code_owner_custom_attribute_to_an_ida.html#handling-celery-tasks message: | Celery tasks need to be decorated with `@set_code_owner_attribute` (from the `edx_django_utils.monitoring` module) in order for us @@ -13,7 +13,7 @@ rules: For more information, see the Celery section of "Add Code_Owner Custom Attributes to an IDA" in the Monitoring How-Tos of - . + . languages: - python patterns: @@ -68,7 +68,7 @@ rules: For more information, see the Celery section of "Add Code_Owner Custom Attributes to an IDA" in the Monitoring How-Tos of - . + . languages: - python patterns: diff --git a/themes/README.rst b/themes/README.rst index ad09d932ea..75bae91493 100644 --- a/themes/README.rst +++ b/themes/README.rst @@ -65,7 +65,7 @@ There are two example themes provided within edx-platform's themes directory: For more details, see `Changing Themes for an Open edX Site`_. -.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/index.html +.. _Changing Themes for an Open edX Site: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/changing_appearance/index.html HTML Templates -------------- diff --git a/themes/open-edx/README.rst b/themes/open-edx/README.rst index 5e4f97acdf..2293941935 100644 --- a/themes/open-edx/README.rst +++ b/themes/open-edx/README.rst @@ -7,8 +7,10 @@ provide any overrides, which means that it adopts the built-in themes, templates etc. The `Red Theme`_ is provided as an example of building a simple new theme. +Another is `Tutor Indigo`_. For more information on building your own theme, see `Changing Themes for an Open edX Site`_. -.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/index.html +.. _Changing Themes for an Open edX Site: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/changing_appearance/index.html .. _Red Theme: https://github.com/openedx/edx-platform/tree/master/themes/red-theme +.. _Tutor Indigo: https://github.com/overhangio/tutor-indigo \ No newline at end of file diff --git a/themes/open-edx/cms/README.rst b/themes/open-edx/cms/README.rst index a6ed83112d..e0fe4272b5 100644 --- a/themes/open-edx/cms/README.rst +++ b/themes/open-edx/cms/README.rst @@ -7,8 +7,10 @@ provide any overrides, which means that it adopts the built-in themes, templates etc. The `Red Theme`_ is provided as an example of building a simple new theme. +Another is `Tutor Indigo`_. For more information on building your own theme, see `Changing Themes for an Open edX Site`_. -.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/index.html +.. _Changing Themes for an Open edX Site: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/changing_appearance/index.html .. _Red Theme: https://github.com/openedx/edx-platform/tree/master/themes/red-theme +.. _Tutor Indigo: https://github.com/overhangio/tutor-indigo \ No newline at end of file diff --git a/themes/open-edx/lms/README.rst b/themes/open-edx/lms/README.rst index 12881f443b..c40581bc61 100644 --- a/themes/open-edx/lms/README.rst +++ b/themes/open-edx/lms/README.rst @@ -7,8 +7,10 @@ provide any overrides, which means that it adopts the built-in themes, templates etc. The `Red Theme`_ is provided as an example of building a simple new theme. +Another is `Tutor Indigo`_. For more information on building your own theme, see `Changing Themes for an Open edX Site`_. -.. _Changing Themes for an Open edX Site: https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/changing_appearance/theming/index.html +.. _Changing Themes for an Open edX Site: https://docs.openedx.org/en/latest/site_ops/install_configure_run_guide/configuration/changing_appearance/index.html .. _Red Theme: https://github.com/openedx/edx-platform/tree/master/themes/red-theme +.. _Tutor Indigo: https://github.com/overhangio/tutor-indigo diff --git a/xmodule/course_block.py b/xmodule/course_block.py index 5b1f92d777..c3f42ecb66 100644 --- a/xmodule/course_block.py +++ b/xmodule/course_block.py @@ -841,8 +841,8 @@ class CourseFields: # lint-amnesty, pylint: disable=missing-class-docstring # Translators: please don't translate "id". help=_( 'Configure team sets, limit team sizes, and set visibility settings using JSON. See ' - 'teams ' + '" + "href='https://docs.openedx.org/en/latest/educators/navigation/components_activities.html#lti-component'>" ) BREAK_TAG = '
    ' diff --git a/xmodule/templates/about/overview.yaml b/xmodule/templates/about/overview.yaml index c5ddfcd97e..be564e38e2 100644 --- a/xmodule/templates/about/overview.yaml +++ b/xmodule/templates/about/overview.yaml @@ -42,7 +42,7 @@ data: |
    diff --git a/xmodule/templates/problem/circuitschematic.yaml b/xmodule/templates/problem/circuitschematic.yaml index 9053718af1..6dc411e258 100644 --- a/xmodule/templates/problem/circuitschematic.yaml +++ b/xmodule/templates/problem/circuitschematic.yaml @@ -12,8 +12,8 @@ data: |

    For more information, see - - Circuit Schematic Builder Problem in Building and Running an edX Course. + + Circuit Schematic Builder Problem in Building and Running an Open edX Course.

    When you add the problem, be sure to select Settings diff --git a/xmodule/templates/problem/customgrader.yaml b/xmodule/templates/problem/customgrader.yaml index f03b259005..1600f2a893 100644 --- a/xmodule/templates/problem/customgrader.yaml +++ b/xmodule/templates/problem/customgrader.yaml @@ -23,8 +23,8 @@ data: | click the "Show Answer" button.

    - For more information, see - Write-Your-Own-Grader Problem in Building and Running an edX Course. + For more information, see + Write-Your-Own-Grader Problem in Building and Running an Open edX Course.

    When you add the problem, be sure to select Settings diff --git a/xmodule/templates/problem/drag_and_drop.yaml b/xmodule/templates/problem/drag_and_drop.yaml index d21afd7426..e4d6b605aa 100644 --- a/xmodule/templates/problem/drag_and_drop.yaml +++ b/xmodule/templates/problem/drag_and_drop.yaml @@ -8,8 +8,8 @@ data: |

    In drag and drop problems, students respond to a question by dragging text or objects to a specific location on an image.

    For more information, see - - Drag and Drop Problem (Deprecated) in Building and Running an edX Course. + + Drag and Drop Problem (Deprecated) in Building and Running an Open edX Course.

    When you add the problem, be sure to select Settings diff --git a/xmodule/templates/problem/imageresponse.yaml b/xmodule/templates/problem/imageresponse.yaml index bb2b189f3f..ace6282572 100644 --- a/xmodule/templates/problem/imageresponse.yaml +++ b/xmodule/templates/problem/imageresponse.yaml @@ -7,9 +7,9 @@ data: |

    In an image mapped input problem, also known as a "pointing on a picture" problem, students click inside a defined region in an image. You define this region by including coordinates in the body of the problem. You can define one rectangular region, multiple rectangular regions, or one non-rectangular region. For more information, see - Image Mapped Input Problem + Image Mapped Input Problem in - Building and Running an edx Course. + Building and Running an Open edX Course.

    When you add the problem, be sure to select Settings diff --git a/xmodule/templates/problem/jsinput_response.yaml b/xmodule/templates/problem/jsinput_response.yaml index dd9fdda164..e931886bdc 100644 --- a/xmodule/templates/problem/jsinput_response.yaml +++ b/xmodule/templates/problem/jsinput_response.yaml @@ -20,13 +20,8 @@ data: |

    For more information, see - - Custom JavaScript Problem in Building and Running an edX Course. -

    -

    - JavaScript developers can also see - - Custom JavaScript Applications in the EdX Developer's Guide. + + Custom JavaScript Problem in Building and Running an Open edX Course.

    When you add the problem, be sure to select Settings diff --git a/xmodule/templates/problem/latex_problem.yaml b/xmodule/templates/problem/latex_problem.yaml index bb3493ce52..4f1e18d3be 100644 --- a/xmodule/templates/problem/latex_problem.yaml +++ b/xmodule/templates/problem/latex_problem.yaml @@ -96,8 +96,8 @@ data: |

    For more information, see - - Problem Written in LaTeX in Building and Running an edX Course. + + Problem Written in LaTeX in Building and Running an Open edX Course.

    You can use the following example problems as models.

    Example Option Problem