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

Author: sarina

source/maintenance_chart_checker.py

@@ -8,7 +8,7 @@
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
 +--------------+-------------------------------+----------------+--------------------------------+
-| 2025-04-13   | reviewer                      | Release        | Pass/Fail                      |
+| 2025-04-13   | reviewer                      | Release        | Pass/Fail/Deprecated           |
 +--------------+-------------------------------+----------------+--------------------------------+
 
 The script generates a summary report showing:
@@ -57,6 +57,7 @@ class MaintenanceStatus(NamedTuple):
     is_empty: bool
     has_fail: bool
     has_pass: bool
+    has_deprecated: bool
     file_path: str
 
 def parse_maintenance_chart(content: str) -> MaintenanceStatus | None:
@@ -94,14 +95,15 @@ def parse_maintenance_chart(content: str) -> MaintenanceStatus | None:
     # Look for pass/fail in test situation column (last column)
     columns = [col.strip().lower() for col in first_data_row.split('|') if col.strip()]
     if not columns:  # Empty row
-        return MaintenanceStatus(True, False, False, "")
+        return MaintenanceStatus(True, False, False, False, "")
 
     # The test situation is in the last column
     test_situation = columns[-1] if len(columns) >= 4 else ""
     has_fail = 'fail' in test_situation.lower()
     has_pass = 'pass' in test_situation.lower()
-    
-    return MaintenanceStatus(is_empty, has_fail, has_pass, "")
+    has_deprecated = 'deprecated' in test_situation.lower()
+
+    return MaintenanceStatus(is_empty, has_fail, has_pass, has_deprecated, "")
 
 def get_folder_path(path: str, start_path: str, depth: int) -> str:
     """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
                         status.is_empty,
                         status.has_fail,
                         status.has_pass,
+                        status.has_deprecated,
                         file_path
                     ))
+
             except Exception as e:
                 print(f"Error processing {file_path}: {e}")
 
@@ -145,8 +149,8 @@ def print_report(results: Dict[str, List[MaintenanceStatus]]):
     print("================================\n")
 
     # Print table header
-    header = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} |".format(
-        "Folder", "Total", "Empty", "Passed", "Failed"
+    header = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} | {:>10} |".format(
+        "Folder", "Total", "Empty", "Passed", "Failed", "Deprecated"
     )
     separator = "-" * len(header)
 
@@ -160,9 +164,10 @@ def print_report(results: Dict[str, List[MaintenanceStatus]]):
         empty = sum(1 for s in statuses if s.is_empty)
         passed = sum(1 for s in statuses if s.has_pass)
         failed = sum(1 for s in statuses if s.has_fail)
+        deprecated = sum(1 for s in statuses if s.has_deprecated)
 
-        row = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} |".format(
-            folder, total, empty, passed, failed
+        row = "| {:<30} | {:>8} | {:>8} | {:>8} | {:>8} | {:>10} |".format(
+            folder, total, empty, passed, failed, deprecated
         )
         print(row)
 

source/site_ops/concepts/index.rst

@@ -3,7 +3,7 @@ Site Operators: Concepts
 
 .. tags:: site operator, concept
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

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

@@ -15,7 +15,7 @@ Follow these steps to enable a waffle flag for a single user. This may be useful
 #. Refresh the page and see that the entered LMS User ID(s) now correspond to their LMS Usernames.
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

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

@@ -51,7 +51,7 @@ Just like how Matamo is integrated we can use other analytics tools as well.
   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>`_.
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

source/site_ops/how-tos/enable_public_course_content.rst

@@ -121,7 +121,7 @@ including the following.
 
 * The Open edX mobile apps do not support public course content.
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

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

@@ -99,7 +99,7 @@ MFE pages
   :alt: A screenshot of the source code showing where to locate the GA4 snippet.
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

source/site_ops/how-tos/index.rst

@@ -9,7 +9,7 @@ Site Operators: How-tos
    *
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

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

@@ -46,7 +46,7 @@ for more about Frontend Plugin Slots and their usage.
 
    :doc:`/community/release_notes/sumac/customizing_learner_dashboard`
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

source/site_ops/index.rst

@@ -21,7 +21,7 @@ Open edX Site Operators
 
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |

source/site_ops/install_configure_run_guide/analytics/index.rst

@@ -41,7 +41,7 @@ is not recommended for use.
 
 
 
-Maintenance Chart
+**Maintenance chart**
 
 +--------------+-------------------------------+----------------+--------------------------------+
 | Review Date  | Working Group Reviewer        |   Release      |Test situation                  |