Todo #12314
closedConvert help shortcut links to server-side redirects
100%
Description
Currently all of the help page redirects reside in /usr/local/www/help.php
and if a new page is added between releases there is no way to update that list.
Rather than have the redirect list on the firewall, it should redirect to the docs site using a specific URL which can then be redirected server side. We've been intending to do this for quite some time, and have all the infrastructure in place, but need to do the final steps.
For example:
- On
firewall_rules.php
the help link points to help.php?page=firewall_rules.php help.php
has an entry in$helppages
which points the entry forfirewall_rules.php
tohttps://docs.netgate.com/pfsense/en/latest/firewall/rule-list-intro.html
This could be changed to:
- On
firewall_rules.php
the help link points to help.php?page=firewall_rules.php help.php
redirects immediately tohttps://docs.netgate.com/pfsense/help/firewall_rules.php
- The redirect config on docs.netgate.com will have a redirect help to the appropriate page as needed, which in this case would be an entry such as:
rewrite ^/pfsense/help/firewall_rules.php /pfsense/en/latest/firewall/rule-list-intro.html permanent;
Once the new redirects are in place we can add new redirects as items get documented without having to update the help.php
file on the firewall.
To me, I've already got the code and redirects ready.
Updated by Jim Pingle about 3 years ago
- Status changed from In Progress to Feedback
- % Done changed from 0 to 100
Applied in changeset 0f2df9bb9f781c0699a40681538e03515e915c7b.
Updated by Jim Pingle about 3 years ago
- Subject changed from Change help redirects to server-side redirects to Convert help shortcut links to server-side redirects
Updating subject for release notes
Updated by Jim Pingle about 3 years ago
- Status changed from Feedback to Resolved
New behavior seems solid. Requests are being routed properly, first to the expected target URL and then redirected to the actual correct document target. All pages I've spot checked have been correct.
If any pages are not going to correct locations they can be handled on a case-by-case basis.
Updated by Jim Pingle about 3 years ago
- Plus Target Version changed from 21.09 to 22.01