Does the Help proxy server need a fix for Joomla 4? Topic is solved

Joomla! Documentation Workgroup

Moderator: Documentation

Post Reply
User avatar
ceford
Joomla! Intern
Joomla! Intern
Posts: 95
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Does the Help proxy server need a fix for Joomla 4?

Post by ceford » Thu Jun 18, 2020 5:06 pm

In Joomla 3 a Help page has a url like this:

https://help.joomla.org/proxy?keyref=He ... it&lang=en

And the H1 Heading says: Extensions Plugin Manager Edit

In Joomla 4 the same Help page has this url:

https://help.joomla.org/proxy?keyref=He ... it&lang=en

And the H1 Heading says: Help4.x:Extensions Plugin Manager Edit

I can't figure out how to suppress the Help4.x: part and think it may be something in the proxy server. Can anyone enlighten me?

 
deleted user

Re: Does the Help proxy server need a fix for Joomla 4?

Post by deleted user » Thu Jun 18, 2020 8:44 pm

ceford wrote:
Thu Jun 18, 2020 5:06 pm
In Joomla 3 a Help page has a url like this:

https://help.joomla.org/proxy?keyref=He ... it&lang=en

And the H1 Heading says: Extensions Plugin Manager Edit

In Joomla 4 the same Help page has this url:

https://help.joomla.org/proxy?keyref=He ... it&lang=en

And the H1 Heading says: Help4.x:Extensions Plugin Manager Edit

I can't figure out how to suppress the Help4.x: part and think it may be something in the proxy server. Can anyone enlighten me?
The code in the proxy server strips prefixes if they match the structure of "Help##" (so "Help39" matches but "Help3.9" doesn't). It seems they are using "Help4.x" as the prefix, if this is a permanent change in structure then the proxy server should be updated to account for this.

User avatar
ceford
Joomla! Intern
Joomla! Intern
Posts: 95
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Does the Help proxy server need a fix for Joomla 4?

Post by ceford » Fri Jun 19, 2020 7:42 am

It seems they are using "Help4.x" as the prefix, if this is a permanent change in structure then the proxy server should be updated to account for this.
I wonder if the use of this prefix was thought through! The index of pages by prefix:

https://docs.joomla.org/index.php?title ... espace=154

is empty for the equivalent Help3.x namespace. There is no Help40 or Help4x listed to choose from. I don't know if it is possible to rename a prefix from Help4.x to Help4x but that is the obvious thing to do.

Perhaps the Documentation team should clarify this before changing the proxy code.

User avatar
ceford
Joomla! Intern
Joomla! Intern
Posts: 95
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Does the Help proxy server need a fix for Joomla 4?

Post by ceford » Thu Jun 25, 2020 2:09 am

The code in the proxy server strips prefixes if they match the structure of "Help##" (so "Help39" matches but "Help3.9" doesn't). It seems they are using "Help4.x" as the prefix, if this is a permanent change in structure then the proxy server should be updated to account for this.
May I formally ask the Documentation team whether it is possible to change the prefix Help4.x to Help4x or Help40? If yes, can it be done? And without breaking the Help screen system.

deleted user

Re: Does the Help proxy server need a fix for Joomla 4?

Post by deleted user » Wed Jul 01, 2020 2:09 pm

The regex used to strip the Help namespace prefix from the page titles has been adjusted to account for the Help4.x namespace.

This does not account for other namespaces such as J3.x as seen on https://help.joomla.org/proxy?keyref=J3.x:Privacy but makes the help screen area consistent now.

Further improvements can be made by submitting issues and/or pull requests to https://github.com/joomla/help.joomla.org as that is the source of the help proxy server code.

User avatar
ceford
Joomla! Intern
Joomla! Intern
Posts: 95
Joined: Mon Feb 24, 2014 10:38 pm
Location: Edinburgh, Scotland
Contact:

Re: Does the Help proxy server need a fix for Joomla 4?

Post by ceford » Wed Jul 01, 2020 3:39 pm

Thank you! I can confirm that the Help screens look much better and this issue is resolved.

 

Post Reply

Return to “docs.joomla.org - Feedback/Information”