Skip to content

Commit a765273

Browse files
authored
fix: fixing the documentation article links (#37493)
* fix: fixing articles The articles were updated because they pointed to the old documentation. * fix: updating articles references The documentation links were pointing to the old documentation and in many cases, these links no longer worked, so we have updated these links to the new documentation.
1 parent 74286fe commit a765273

5 files changed

Lines changed: 47 additions & 47 deletions

File tree

cms/envs/help_tokens.ini

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22
# NOTE: If any of these page settings change, their corresponding test must be updated
33
# in edx-platform/common/test/acceptance/tests/studio/test_studio.help.py
44
[pages]
5-
default = course_author:index.html
6-
home = course_author:getting_started/CA_get_started_Studio.html
7-
develop_course = course_author:developing_course/index.html
8-
outline = course_author:developing_course/course_outline.html
9-
unit = course_author:developing_course/course_units.html
10-
visibility = course_author:developing_course/controlling_content_visibility.html
11-
updates = course_author:course_assets/handouts_updates.html
12-
pages = course_author:course_assets/pages.html
13-
files = course_author:course_assets/course_files.html
14-
textbooks = course_author:course_assets/textbooks.html
15-
schedule = course_author:set_up_course/studio_add_course_information/index.html
16-
grading = course_author:grading/index.html
17-
team_course = course_author:set_up_course/studio_add_course_information/studio_course_staffing.html
18-
team_library = course_author:course_components/libraries.html#give-other-users-access-to-your-library
19-
advanced = course_author:index.html
20-
checklist = course_author:set_up_course/index.html
21-
import_library = course_author:course_components/libraries.html#import-a-library
22-
import_course = course_author:releasing_course/export_import_course.html#import-a-course
23-
export_library = course_author:course_components/libraries.html#export-a-library
24-
export_course = course_author:releasing_course/export_import_course.html#export-a-course
25-
welcome = course_author:getting_started/index.html
26-
login = course_author:getting_started/index.html
27-
register = course_author:getting_started/index.html
28-
content_libraries = course_author:course_components/libraries.html
29-
content_groups = course_author:course_features/cohorts/cohorted_courseware.html
30-
enrollment_tracks = course_author:course_features/diff_content/enroll_track_courseware.html
31-
group_configurations = course_author:course_features/content_experiments/content_experiments_configure.html#set-up-group-configurations-in-edx-studio
32-
container = course_author:developing_course/course_components.html#components-that-contain-other-components
33-
video = course_author:video/index.html
34-
certificates = course_author:set_up_course/studio_add_course_information/studio_creating_certificates.html
35-
content_highlights = course_author:developing_course/course_sections.html#set-course-section-highlights
36-
image_accessibility = course_author:accessibility/best_practices_course_content_dev.html#use-best-practices-for-describing-images
37-
social_sharing = course_author:developing_course/social_sharing.html
5+
default = course_author:quickstarts/build_a_course.html
6+
home = course_author:concepts/open_edx_platform/what_is_studio.html
7+
develop_course = course_author:how-tos/set_up_course/create_new_course.html
8+
outline = course_author:concepts/open_edx_platform/about_course_outline.html
9+
unit = course_author:concepts/open_edx_platform/about_course_units.html
10+
visibility = course_author:references/controlling_content_visibility.html
11+
updates = course_author:concepts/communication/about_course_updates_handouts.html
12+
pages = course_author:how-tos/course_development/manage_custom_page.html
13+
files = course_author:references/course_development/files_page.html
14+
textbooks = course_author:how-tos/course_development/manage_textbooks.html
15+
schedule = course_author:how-tos/set_up_course/set_course_schedule.html
16+
grading = course_author:how-tos/grading/set_grade_range.html
17+
team_course = course_author:references/course_development/course_team_roles.html
18+
team_library = course_author:how-tos/course_development/add_users_to_libraries.html
19+
advanced = course_author:quickstarts/build_a_course.html
20+
checklist = course_author:concepts/releasing-course/course_launch_checklist.html
21+
import_library = course_author:how-tos/course_development/export_import_library.html#import-a-legacy-library
22+
import_course = course_author:how-tos/releasing-course/import_course.html
23+
export_library = course_author:how-tos/course_development/export_import_library.html#export-a-legacy-library
24+
export_course = course_author:how-tos/releasing-course/export_course.html
25+
welcome = course_author:index.html
26+
login = course_author:index.html
27+
register = course_author:index.html
28+
content_libraries = course_author:concepts/instructional_design/libraries.html
29+
content_groups = course_author:concepts/advanced_features/about_content_groups.html
30+
enrollment_tracks = course_author:how-tos/student_management/manage_course_enrollments.html
31+
group_configurations = course_author:concepts/advanced_features/about_content_groups.html
32+
container = course_author:references/course_development/parent_child_components.html
33+
video = course_author:references/course_development/guide_to_video.html
34+
certificates = course_author:concepts/open_edx_platform/about_certificates.html
35+
content_highlights = course_author:how-tos/course_development/manage_course_highlight_emails.html
36+
image_accessibility = course_author:references/accessibility/accessibility_best_practices_checklist.html#use-best-practices-for-describing-images
37+
social_sharing = course_author:how-tos/course_development/social_sharing.html
3838

3939
# below are the language directory names for the different locales
4040
[locales]

cms/envs/mock.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -481,8 +481,8 @@ GRADES_DOWNLOAD:
481481
querystring_expire: 300
482482
STORAGE_TYPE: ''
483483
HELP_TOKENS_BOOKS:
484-
course_author: https://edx.readthedocs.io/projects/edx-partner-course-staff
485-
learner: https://edx.readthedocs.io/projects/edx-guide-for-students
484+
course_author: https://docs.openedx.org/en/latest/educators
485+
learner: https://docs.openedx.org/en/latest/learners
486486
HOTJAR_ID: 7890
487487
ICP_LICENSE: icp_license
488488
ICP_LICENSE_INFO:

lms/envs/help_tokens.ini

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@
33
# in edx-platform/common/test/acceptance/tests/lms/test_lms_help.py
44
[pages]
55
default = learner:index.html
6-
instructor = course_author:CA_instructor_dash_help.html
6+
instructor = course_author:index.html
77
course = learner:index.html
8-
profile = learner:SFD_dashboard_profile_SectionHead.html#adding-profile-information
9-
dashboard = learner:SFD_dashboard_profile_SectionHead.html
8+
profile = learner:concepts/open_edx_platform/what_is_profile_page.html
9+
dashboard = learner:concepts/open_edx_platform/what_is_course_dashboard.html
1010
courseinfo = learner:SFD_start_course.html
1111
progress = learner:SFD_check_progress.html
12-
learneraccountsettings = learner:SFD_update_acct_settings.html
13-
learnerdashboard = learner:SFD_dashboard_profile_SectionHead.html
14-
programs = learner:SFD_enrolling.html
12+
learneraccountsettings = learner:how-tos/update_course_specific_settings.html
13+
learnerdashboard = learner:concepts/open_edx_platform/what_is_course_dashboard.html
14+
programs = learner:OpenSFD_enrolling.html
1515
bookmarks = learner:SFD_bookmarks.html
1616
notes = learner:SFD_notes.html
1717
wiki = learner:SFD_wiki.html
1818
discussions = learner:sfd_discussions/index.html
1919

20-
cohortmanual = course_author:course_features/cohorts/cohort_config.html#assign-learners-to-cohorts-manually
21-
cohortautomatic = course_author:course_features/cohorts/cohorts_overview.html#all-automated-assignment
20+
cohortmanual = course_author:references/advanced_features/managing_cohort_assignment.html#implementing-a-manual-assignment-strategy
21+
cohortautomatic = course_author:references/advanced_features/managing_cohort_assignment.html#implementing-an-automated-assignment-strategy
2222

2323
# below are the language directory names for the different locales
2424
[locales]

lms/envs/mock.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,8 +686,8 @@ GRADES_DOWNLOAD:
686686
querystring_expire: 300
687687
STORAGE_TYPE: ''
688688
HELP_TOKENS_BOOKS:
689-
course_author: http://edx.readthedocs.io/projects/open-edx-building-and-running-a-course
690-
learner: http://edx.readthedocs.io/projects/open-edx-learner-guide
689+
course_author: https://docs.openedx.org/en/latest/educators
690+
learner: https://docs.openedx.org/en/latest/learners
691691
HIBP_LOGIN_BLOCK_PASSWORD_FREQUENCY_THRESHOLD: 5
692692
HOME_MICROFRONTEND_URL: hello
693693
HOTJAR_SITE_ID: 12345

openedx/envs/common.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2068,8 +2068,8 @@ def _make_locale_paths(settings):
20682068
HELP_TOKENS_VERSION = Derived(lambda settings: doc_version())
20692069

20702070
HELP_TOKENS_BOOKS = {
2071-
'learner': 'https://edx.readthedocs.io/projects/open-edx-learner-guide',
2072-
'course_author': 'https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course',
2071+
'learner': 'https://docs.openedx.org/en/latest/learners',
2072+
'course_author': 'https://docs.openedx.org/en/latest/educators',
20732073
}
20742074

20752075
################################ Retirement ################################

0 commit comments

Comments
 (0)