Skip to content

Commit e587999

Browse files
sarinasarina
authored
Fix formatting of **Maintenance chart** in site_ops files (#1009)
* Fix formatting of **Maintenance chart** in site_ops files * Add Deprecated status to maintenance chart * Deprecate site ops pages that are no longer supported
1 parent 28af8dc commit e587999

File tree

120 files changed

+172
-167
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

120 files changed

+172
-167
lines changed

‎source/maintenance_chart_checker.py

+13-8
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
+--------------+-------------------------------+----------------+--------------------------------+
99
| Review Date | Working Group Reviewer | Release |Test situation |
1010
+--------------+-------------------------------+----------------+--------------------------------+
11-
| 2025-04-13 | reviewer | Release | Pass/Fail |
11+
| 2025-04-13 | reviewer | Release | Pass/Fail/Deprecated |
1212
+--------------+-------------------------------+----------------+--------------------------------+
1313
1414
The script generates a summary report showing:
@@ -57,6 +57,7 @@ class MaintenanceStatus(NamedTuple):
5757
is_empty: bool
5858
has_fail: bool
5959
has_pass: bool
60+
has_deprecated: bool
6061
file_path: str
6162

6263
def parse_maintenance_chart(content: str) -> MaintenanceStatus | None:
@@ -94,14 +95,15 @@ def parse_maintenance_chart(content: str) -> MaintenanceStatus | None:
9495
# Look for pass/fail in test situation column (last column)
9596
columns = [col.strip().lower() for col in first_data_row.split('|') if col.strip()]
9697
if not columns: # Empty row
97-
return MaintenanceStatus(True, False, False, "")
98+
return MaintenanceStatus(True, False, False, False, "")
9899

99100
# The test situation is in the last column
100101
test_situation = columns[-1] if len(columns) >= 4 else ""
101102
has_fail = 'fail' in test_situation.lower()
102103
has_pass = 'pass' in test_situation.lower()
103-
104-
return MaintenanceStatus(is_empty, has_fail, has_pass, "")
104+
has_deprecated = 'deprecated' in test_situation.lower()
105+
106+
return MaintenanceStatus(is_empty, has_fail, has_pass, has_deprecated, "")
105107

106108
def get_folder_path(path: str, start_path: str, depth: int) -> str:
107109
"""Get the directory path at specified depth relative to start_path."""
@@ -132,8 +134,10 @@ def scan_directory(start_path: str, depth: int) -> Dict[str, List[MaintenanceSta
132134
status.is_empty,
133135
status.has_fail,
134136
status.has_pass,
137+
status.has_deprecated,
135138
file_path
136139
))
140+
137141
except Exception as e:
138142
print(f"Error processing {file_path}: {e}")
139143

@@ -145,8 +149,8 @@ def print_report(results: Dict[str, List[MaintenanceStatus]]):
145149
print("================================\n")
146150

147151
# Print table header
148-
header = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} |".format(
149-
"Folder", "Total", "Empty", "Passed", "Failed"
152+
header = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} | {:>10} |".format(
153+
"Folder", "Total", "Empty", "Passed", "Failed", "Deprecated"
150154
)
151155
separator = "-" * len(header)
152156

@@ -160,9 +164,10 @@ def print_report(results: Dict[str, List[MaintenanceStatus]]):
160164
empty = sum(1 for s in statuses if s.is_empty)
161165
passed = sum(1 for s in statuses if s.has_pass)
162166
failed = sum(1 for s in statuses if s.has_fail)
167+
deprecated = sum(1 for s in statuses if s.has_deprecated)
163168

164-
row = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} |".format(
165-
folder, total, empty, passed, failed
169+
row = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} | {:>10} |".format(
170+
folder, total, empty, passed, failed, deprecated
166171
)
167172
print(row)
168173

‎source/site_ops/concepts/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Site Operators: Concepts
33

44
.. tags:: site operator, concept
55

6-
Maintenance Chart
6+
**Maintenance chart**
77

88
+--------------+-------------------------------+----------------+--------------------------------+
99
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/add-waffle-flag-for-user.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Follow these steps to enable a waffle flag for a single user. This may be useful
1515
#. Refresh the page and see that the entered LMS User ID(s) now correspond to their LMS Usernames.
1616

1717

18-
Maintenance Chart
18+
**Maintenance chart**
1919

2020
+--------------+-------------------------------+----------------+--------------------------------+
2121
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/configuring-site-wide-analytics-tools.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Just like how Matamo is integrated we can use other analytics tools as well.
5151
This will only be applied to the pages served by LMS and would not be supported by different MFEs used by the platform. Hence, to introduce the same, you need to create a custom component and put it in a slot. You can have a look at the `frontend-footer-component <https://github.com/openedx/frontend-component-footer>`_.
5252

5353

54-
Maintenance Chart
54+
**Maintenance chart**
5555

5656
+--------------+-------------------------------+----------------+--------------------------------+
5757
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/enable_public_course_content.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ including the following.
121121

122122
* The Open edX mobile apps do not support public course content.
123123

124-
Maintenance Chart
124+
**Maintenance chart**
125125

126126
+--------------+-------------------------------+----------------+--------------------------------+
127127
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/google-analytics.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ MFE pages
9999
:alt: A screenshot of the source code showing where to locate the GA4 snippet.
100100

101101

102-
Maintenance Chart
102+
**Maintenance chart**
103103

104104
+--------------+-------------------------------+----------------+--------------------------------+
105105
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Site Operators: How-tos
99
*
1010

1111

12-
Maintenance Chart
12+
**Maintenance chart**
1313

1414
+--------------+-------------------------------+----------------+--------------------------------+
1515
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/how-tos/use-frontend-plugin-slots.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ for more about Frontend Plugin Slots and their usage.
4646

4747
:doc:`/community/release_notes/sumac/customizing_learner_dashboard`
4848

49-
Maintenance Chart
49+
**Maintenance chart**
5050

5151
+--------------+-------------------------------+----------------+--------------------------------+
5252
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Open edX Site Operators
2121

2222

2323

24-
Maintenance Chart
24+
**Maintenance chart**
2525

2626
+--------------+-------------------------------+----------------+--------------------------------+
2727
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/analytics/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ is not recommended for use.
4141

4242

4343

44-
Maintenance Chart
44+
**Maintenance chart**
4545

4646
+--------------+-------------------------------+----------------+--------------------------------+
4747
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/drag_and_drop_problem_styling.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Python module, follow these steps.
8787
.. include:: /links.txt
8888

8989

90-
Maintenance Chart
90+
**Maintenance chart**
9191

9292
+--------------+-------------------------------+----------------+--------------------------------+
9393
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ way they look.
1818
.. For more information about how you set up sites, see :ref:`Configuring Open edX Sites`.
1919
2020
21-
Maintenance Chart
21+
**Maintenance chart**
2222

2323
+--------------+-------------------------------+----------------+--------------------------------+
2424
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/compiling_theme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ To update a theme for the E-commerce service, follow these steps.
9595

9696

9797

98-
Maintenance Chart
98+
**Maintenance chart**
9999

100100
+--------------+-------------------------------+----------------+--------------------------------+
101101
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/create_theme.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ subdirectories, you can apply the theme to both the LMS and Studio.
115115
your UI. For more information, see :ref:`Compiling a Theme`.
116116

117117

118-
Maintenance Chart
118+
**Maintenance chart**
119119

120120
+--------------+-------------------------------+----------------+--------------------------------+
121121
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/enable_themes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ To apply a theme to an Open edX site, follow these steps.
171171

172172

173173

174-
Maintenance Chart
174+
**Maintenance chart**
175175

176176
+--------------+-------------------------------+----------------+--------------------------------+
177177
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ In addition, an `example theme <https://github.com/openedx/sample-themes>`_ is
3939
available for review.
4040

4141

42-
Maintenance Chart
42+
**Maintenance chart**
4343

4444
+--------------+-------------------------------+----------------+--------------------------------+
4545
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/overview_themes.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For more information about Open edX sites, see :ref:`Configuring Open edX
2323
Sites`.
2424

2525

26-
Maintenance Chart
26+
**Maintenance chart**
2727

2828
+--------------+-------------------------------+----------------+--------------------------------+
2929
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/changing_appearance/theming/theme_directories.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The following subdirectories hold the UI files that you can override.
6262
HTML for UI pages.
6363

6464

65-
Maintenance Chart
65+
**Maintenance chart**
6666

6767
+--------------+-------------------------------+----------------+--------------------------------+
6868
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/config_allowed_regis_emails.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ To specify the email patterns that are allowed for registration, follow these st
7171
#. Restart your ``edxapp`` instances.
7272

7373

74-
Maintenance Chart
74+
**Maintenance chart**
7575

7676
+--------------+-------------------------------+----------------+--------------------------------+
7777
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/configure_milestone_app.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Configure the Milestones Application
1818
#. Run database migrations.
1919

2020

21-
Maintenance Chart
21+
**Maintenance chart**
2222

2323
+--------------+-------------------------------+----------------+--------------------------------+
2424
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/customize_registration_page.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ To add custom fields to the registration page, follow these steps.
6969
.. include:: /links.txt
7070

7171

72-
Maintenance Chart
72+
**Maintenance chart**
7373

7474
+--------------+-------------------------------+----------------+--------------------------------+
7575
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/deprecated_add_course_talk_widget.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ To add the CourseTalk widget, follow these steps.
6060
.. include:: /links.txt
6161

6262

63-
Maintenance Chart
63+
**Maintenance chart**
6464

6565
+--------------+-------------------------------+----------------+--------------------------------+
6666
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/edx_search.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ LMS
195195
.. include:: /links.txt
196196

197197

198-
Maintenance Chart
198+
**Maintenance chart**
199199

200200
+--------------+-------------------------------+----------------+--------------------------------+
201201
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_ccx.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Open edX, you must configure the ``server-vars.yml`` file in the edX platform.
3434
.. include:: /links.txt
3535

3636

37-
Maintenance Chart
37+
**Maintenance chart**
3838

3939
+--------------+-------------------------------+----------------+--------------------------------+
4040
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ will have been generated for eligible learners.
405405
.. _edx/credentials: https://github.com/openedx/credentials
406406

407407

408-
Maintenance Chart
408+
**Maintenance chart**
409409

410410
+--------------+-------------------------------+----------------+--------------------------------+
411411
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_custom_course_settings.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ of Open edX, you must configure the ``studio.yml`` file in the edX platform.
2727
.. include:: /links.txt
2828

2929

30-
Maintenance Chart
30+
**Maintenance chart**
3131

3232
+--------------+-------------------------------+----------------+--------------------------------+
3333
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_discussion_notifications.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ of Open edX.
6565
.. include:: /links.txt
6666

6767

68-
Maintenance Chart
68+
**Maintenance chart**
6969

7070
+--------------+-------------------------------+----------------+--------------------------------+
7171
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_entrance_exams.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ files, which are located one level above the ``edx-platform`` directory.
5252
.. include:: /links.txt
5353

5454

55-
Maintenance Chart
55+
**Maintenance chart**
5656

5757
+--------------+-------------------------------+----------------+--------------------------------+
5858
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_licensing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ files, which are located one level above the ``edx-platform`` directory.
5555
.. include:: /links.txt
5656

5757

58-
Maintenance Chart
58+
**Maintenance chart**
5959

6060
+--------------+-------------------------------+----------------+--------------------------------+
6161
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_pacing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ using the Django administration console for your Open edX LMS.
5454
.. include:: /links.txt
5555

5656

57-
Maintenance Chart
57+
**Maintenance chart**
5858

5959
+--------------+-------------------------------+----------------+--------------------------------+
6060
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_prerequisites.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ directory.
5454
.. include:: /links.txt
5555

5656

57-
Maintenance Chart
57+
**Maintenance chart**
5858

5959
+--------------+-------------------------------+----------------+--------------------------------+
6060
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_public_course.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ including the following.
124124
.. include:: /links.txt
125125

126126

127-
Maintenance Chart
127+
**Maintenance chart**
128128

129129
+--------------+-------------------------------+----------------+--------------------------------+
130130
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ instance of Open edX.
145145
.. include:: /links.txt
146146

147147

148-
Maintenance Chart
148+
**Maintenance chart**
149149

150150
+--------------+-------------------------------+----------------+--------------------------------+
151151
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_timed_exams.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ directory.
5454
.. include:: /links.txt
5555

5656

57-
Maintenance Chart
57+
**Maintenance chart**
5858

5959
+--------------+-------------------------------+----------------+--------------------------------+
6060
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/enable_weekly_learning_goals.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The script does a number of checks before sending emails. There are five main co
4646
.. note:: For the emails to work you will need to have at least one email channel configured within https://github.com/openedx/edx-ace
4747

4848

49-
Maintenance Chart
49+
**Maintenance chart**
5050

5151
+--------------+-------------------------------+----------------+--------------------------------+
5252
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ configuration options.
4242
retrieve_extended_profile_metadata
4343

4444

45-
Maintenance Chart
45+
**Maintenance chart**
4646

4747
+--------------+-------------------------------+----------------+--------------------------------+
4848
| Review Date | Working Group Reviewer | Release |Test situation |

‎source/site_ops/install_configure_run_guide/configuration/install_xblock.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ information, see :ref:`Enable Additional Exercises and Tools`.
4848
.. include:: /links.txt
4949

5050

51-
Maintenance Chart
51+
**Maintenance chart**
5252

5353
+--------------+-------------------------------+----------------+--------------------------------+
5454
| Review Date | Working Group Reviewer | Release |Test situation |

0 commit comments

Comments
 (0)