Skip to content
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.

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

[5.1] Fix build tool helpTOC.php #43250

Merged
merged 5 commits into from
May 11, 2024

Conversation

LadySolveig
Copy link
Contributor

Pull Request for Issue #32419 .

Summary of Changes

Fix build tool for missing help documents in Help index.

grafik

  • loop through all categories in all minor versions to get all media wiki categories for the major version
  • grap missing language strings into array
  • write missing strings to temporary file /tmp/missing-helptoc.txt for revision and manually add to administrator/language/en-GB/com_admin.ini

Testing Instructions

composer i
php ./build/helpTOC.php

Actual result BEFORE applying this Pull Request

grafik

Expected result AFTER applying this Pull Request

grafik

Link to documentations

Please select:

  • Documentation link for docs.joomla.org:

  • No documentation changes for docs.joomla.org needed

  • Pull Request link for manual.joomla.org:

  • No documentation changes for manual.joomla.org needed

- loop through all  categories in all minor versions to get all media wiki categories for the major version
- grap missing language strings into array
- write missing strings to temporary file for revision and manually add to 'administrator/language/en-GB/com_admin.ini'
build/helpTOC.php Outdated Show resolved Hide resolved
LadySolveig and others added 2 commits April 10, 2024 19:44
Co-authored-by: Brian Teeman <brian@teeman.net>
@LadySolveig LadySolveig modified the milestone: Joomla! 5.1.0 Apr 10, 2024
@brianteeman
Copy link
Contributor

Definitely an improvement on the old script.

Tested with en-GB only. Not sure how the process will work for other languages


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.

@brianteeman
Copy link
Contributor

I have tested this item ✅ successfully on accd60d


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.

@ceford
Copy link
Contributor

ceford commented Apr 11, 2024

I have tested this item ✅ successfully on accd60d

I have been through the code and I am pleased we do not have to edit all of the MediaWiki files in the Category 5.0 to add Category 5.1.

I have reservations about adding 100+ missing strings to administrator/language/en-GB/com_admin.ini - that makes the list of Help pages more than twice as long and it is the only place where the missing strings are used.


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.

@LadySolveig
Copy link
Contributor Author

@ceford I agree with you about the language strings - I actually see this more as a partial fix to minimise rework in the wiki and still get the most up-to-date help index possible.
The Help Index hasn't received the attention it deserves since 4.3 and I'm afraid there's little point in continuing to rely on this workflow. In the long run, we really need a long-term solution for our wiki.
Also to optimise the workflow and reduce manual work for the Documentation Team and also for you as a very dedicated member, which I appreciate so much!

@brianteeman
Copy link
Contributor

When I looked at the strings it made me realise that the toc would benefit from nesting.
There are over 20 admin modules which could be nested to one etc

@Quy
Copy link
Contributor

Quy commented Apr 12, 2024

RTC


This comment was created with the J!Tracker Application at issues.joomla.org/tracker/joomla-cms/43250.

@joomla-cms-bot joomla-cms-bot added the RTC This Pull Request is Ready To Commit label Apr 12, 2024
@HLeithner HLeithner added the bug label Apr 24, 2024
@bembelimen bembelimen added this to the Joomla! 5.1.1 milestone May 11, 2024
@bembelimen bembelimen merged commit b122c7a into joomla:5.1-dev May 11, 2024
0 of 2 checks passed
@bembelimen
Copy link
Contributor

Thanks!

@joomla-cms-bot joomla-cms-bot removed the RTC This Pull Request is Ready To Commit label May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants