Skip to content

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

Merged
jswope00 merged 3 commits into
mainfrom
fixup-ops-chart-formatting
Apr 23, 2025
Merged

Fix formatting of **Maintenance chart** in site_ops files#1009
jswope00 merged 3 commits into
mainfrom
fixup-ops-chart-formatting

Conversation

@sarina
Copy link
Copy Markdown
Contributor

@sarina sarina commented Apr 16, 2025

Before this change:

❯ python maintenance_chart_checker.py             

Maintenance Chart Analysis Report
================================

------------------------------------------------------------------------------
| Folder                         |    Total |    Empty |   Passed |   Failed |
------------------------------------------------------------------------------
| developers                     |       58 |       55 |        0 |        0 |
| documentors                    |       19 |       19 |        0 |        0 |
| educators                      |      337 |      258 |       62 |       15 |
| learners                       |       37 |       37 |        0 |        0 |
| translators                    |        8 |        8 |        0 |        0 |
------------------------------------------------------------------------------

After:

docs.openedx.org/source on 💁🏼‍♀️ fixup-ops-chart-formatting [$] via 🐍 v3.12.9 (vdocs.openedx.org) 
❯ python maintenance_chart_checker.py

Maintenance Chart Analysis Report
================================

------------------------------------------------------------------------------
| Folder                         |    Total |    Empty |   Passed |   Failed |
------------------------------------------------------------------------------
| developers                     |       58 |       55 |        0 |        0 |
| documentors                    |       19 |       19 |        0 |        0 |
| educators                      |      337 |      258 |       62 |       15 |
| learners                       |       37 |       37 |        0 |        0 |
| site_ops                       |      119 |       76 |        4 |       39 |
| translators                    |        8 |        8 |        0 |        0 |
------------------------------------------------------------------------------

@sarina
Copy link
Copy Markdown
Contributor Author

sarina commented Apr 16, 2025

@jswope00 I wonder if we want to consider a third state (beyond "pass/fail") to indicate deprecated pages that will never pass. Maybe just "Deprecated"?

@jswope00
Copy link
Copy Markdown
Contributor

@jswope00 I wonder if we want to consider a third state (beyond "pass/fail") to indicate deprecated pages that will never pass. Maybe just "Deprecated"?

how will we know it is deprecated? One thing this script does is it only includes pages where a maintenance table actually exists. That way, we don't count untestable pages like table of content or navigation pages. If we put any kind of note that isn't a maintenance table on a deprecated page then it won't be included. Does that suffice or would you rather they be in the final report?

@sarina
Copy link
Copy Markdown
Contributor Author

sarina commented Apr 17, 2025

I was just thinking about a third state in the maintenance table:

  • Fail
  • Pass
  • Deprecated

and then updating the report script with another column. I think we'll be in a place where a previously Passed file may transition to Deprecated, and I don't think it's right to just remove the maintenance table in that case.

@sarina
Copy link
Copy Markdown
Contributor Author

sarina commented Apr 19, 2025

@jswope00 I added a separate commit to look at that allows us to have Deprecated pages. Take a look at the pages I've marked as Deprecated - does it make sense to you?


Maintenance Chart Analysis Report
================================

-------------------------------------------------------------------------------------------
| Folder                         |    Total |    Empty |   Passed |   Failed | Deprecated |
-------------------------------------------------------------------------------------------
| developers                     |       58 |       55 |        0 |        0 |          0 |
| documentors                    |       19 |       19 |        0 |        0 |          0 |
| educators                      |      337 |      258 |       62 |       15 |          0 |
| learners                       |       37 |       37 |        0 |        0 |          0 |
| site_ops                       |      119 |       75 |        4 |       22 |         39 |
| translators                    |        8 |        8 |        0 |        0 |          0 |
-------------------------------------------------------------------------------------------

@jswope00
Copy link
Copy Markdown
Contributor

Nice!

@jswope00 jswope00 merged commit e587999 into main Apr 23, 2025
2 checks passed
@jswope00 jswope00 deleted the fixup-ops-chart-formatting branch April 23, 2025 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants