Skip to content

Fix formatting of **Maintenance chart** in site_ops files #1009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jswope00 merged 3 commits into from
Apr 23, 2025
Merged

Fix formatting of **Maintenance chart** in site_ops files #1009

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a003aa
Fix formatting of **Maintenance chart** in site_ops files
sarina Apr 16, 2025
9fb9cd1
Add Deprecated status to maintenance chart
sarina Apr 19, 2025
b1530cb
Deprecate site ops pages that are no longer supported
sarina Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions source/maintenance_chart_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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."""
Expand Down Expand Up @@ -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}")

Expand All @@ -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)

Expand All @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/concepts/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Site Operators: Concepts

.. tags:: site operator, concept

Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/add-waffle-flag-for-user.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/configuring-site-wide-analytics-tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/enable_public_course_content.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/google-analytics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Site Operators: How-tos
*


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/how-tos/use-frontend-plugin-slots.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Open edX Site Operators



Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/analytics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ is not recommended for use.



Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...e_run_guide/configuration/changing_appearance/drag_and_drop_problem_styling.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Python module, follow these steps.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...ite_ops/install_configure_run_guide/configuration/changing_appearance/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ way they look.
.. For more information about how you set up sites, see :ref:`Configuring Open edX Sites`.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...nfigure_run_guide/configuration/changing_appearance/theming/compiling_theme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ To update a theme for the E-commerce service, follow these steps.



Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ..._configure_run_guide/configuration/changing_appearance/theming/create_theme.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ subdirectories, you can apply the theme to both the LMS and Studio.
your UI. For more information, see :ref:`Compiling a Theme`.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...configure_run_guide/configuration/changing_appearance/theming/enable_themes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ To apply a theme to an Open edX site, follow these steps.



Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...install_configure_run_guide/configuration/changing_appearance/theming/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ In addition, an `example theme <https://github.com/openedx/sample-themes>`_ is
available for review.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...nfigure_run_guide/configuration/changing_appearance/theming/overview_themes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For more information about Open edX sites, see :ref:`Configuring Open edX
Sites`.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...igure_run_guide/configuration/changing_appearance/theming/theme_directories.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The following subdirectories hold the UI files that you can override.
HTML for UI pages.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...e_ops/install_configure_run_guide/configuration/config_allowed_regis_emails.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To specify the email patterns that are allowed for registration, follow these st
#. Restart your ``edxapp`` instances.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion .../site_ops/install_configure_run_guide/configuration/configure_milestone_app.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Configure the Milestones Application
#. Run database migrations.


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...e_ops/install_configure_run_guide/configuration/customize_registration_page.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To add custom fields to the registration page, follow these steps.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...install_configure_run_guide/configuration/deprecated_add_course_talk_widget.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ To add the CourseTalk widget, follow these steps.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/edx_search.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ LMS
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_ccx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Open edX, you must configure the ``server-vars.yml`` file in the edX platform.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_certificates.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ will have been generated for eligible learners.
.. _edx/credentials: https://github.com/openedx/credentials


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...ops/install_configure_run_guide/configuration/enable_custom_course_settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ of Open edX, you must configure the ``studio.yml`` file in the edX platform.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...s/install_configure_run_guide/configuration/enable_discussion_notifications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ of Open edX.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...ce/site_ops/install_configure_run_guide/configuration/enable_entrance_exams.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ files, which are located one level above the ``edx-platform`` directory.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_licensing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ files, which are located one level above the ``edx-platform`` directory.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_pacing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ using the Django administration console for your Open edX LMS.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_prerequisites.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ directory.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_public_course.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ including the following.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ...te_ops/install_configure_run_guide/configuration/enable_socialsharing_icons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ instance of Open edX.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/enable_timed_exams.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ directory.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion ..._ops/install_configure_run_guide/configuration/enable_weekly_learning_goals.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The script does a number of checks before sending emails. There are five main co
.. note:: For the emails to work you will need to have at least one email channel configured within https://github.com/openedx/edx-ace


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ configuration options.
retrieve_extended_profile_metadata


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
2 changes: 1 addition & 1 deletion source/site_ops/install_configure_run_guide/configuration/install_xblock.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ information, see :ref:`Enable Additional Exercises and Tools`.
.. include:: /links.txt


Maintenance Chart
**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
Expand Down
Loading