#57726 closed defect (bug) (fixed)
Use the new /documentation/ URLs for HelpHub links
Reported by: | SergeyBiryukov | Owned by: | audrasjb |
---|---|---|---|
Milestone: | 6.2 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Help/About | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
https://wordpress.org/support/ was recently redirected to https://wordpress.org/documentation/. That includes the root /support/
page, as well as all /support/article/*
pages, with the exception of support forums at https://wordpress.org/support/forums/.
This has some consequences for core:
- All
/support/article/*
URLs should be redirected to/documentation/article/*
to avoid an extra redirect. - Links like this in Help tabs look confusing now:
'<p><strong>' . __( 'For more information:' ) . '</strong></p>' . '<p>' . __( '<a href="https://wordpress.org/support/article/comments-screen/">Documentation on Comments</a>' ) . '</p>' . '<p>' . __( '<a href="https://wordpress.org/support/">Support</a>' ) . '</p>'
- The second link says Support, but links to a page called Documentation.
- We could update it to:
'<p>' . __( '<a href="https://wordpress.org/documentation/">Documentation</a>' ) . '</p>'
but then the whole list looks a bit weird:
For more information:
- Documentation on Comments
- Documentation (on what?)
- Should the second link be updated to https://wordpress.org/support/forums/ instead?
Note: The old /support/article/*
URLs still work (with a redirect to the new location), so this can be moved to 6.3 if preferred, but I think it would be a better user experience to at least address the first item here for 6.2.
Change History (41)
#2
follow-up:
↓ 5
@
22 months ago
ah, and for the second link ("Support"), as far as I know, this was implemented as a link to the support forum main page.
#3
@
22 months ago
- Owner set to audrasjb
- Status changed from new to assigned
I'll make sure to have a patch for this ticket by tomorrow morning :)
This ticket was mentioned in PR #4080 on WordPress/wordpress-develop by @audrasjb.
22 months ago
#4
- Keywords has-patch has-unit-tests added
#5
in reply to:
↑ 2
;
follow-up:
↓ 6
@
22 months ago
Replying to audrasjb:
ah, and for the second link ("Support"), as far as I know, this was implemented as a link to the support forum main page.
Yeah, it used to be the support forums main page before the 2017 redesign:
http://web.archive.org/web/20170101112647/wordpress.org/support/
That page is now https://wordpress.org/support/forums/.
https://wordpress.org/support/ just redirects to https://wordpress.org/documentation/ :)
#6
in reply to:
↑ 5
@
22 months ago
Replying to SergeyBiryukov:
That page is now https://wordpress.org/support/forums/.
So I guess that should be the new URL if we want to keep the link text as "Support".
This ticket was mentioned in PR #4081 on WordPress/wordpress-develop by @dhrupo.
22 months ago
#8
Hi, I have changed all /support/article/* redirected to /documentation/article/* for documentation and all /support/ to /support/forums for support in all files.
Trac ticket: https://core.trac.wordpress.org/ticket/57726
#9
@
22 months ago
@audrasjb @SergeyBiryukov hi there,
I have updated all of the code in all PHP files as
- /support/article/* to /documentation/article/*
- /support/ to /support/forums
Please check and let me know
@audrasjb commented on PR #4081:
22 months ago
#10
Thanks for the PR, however I'm already working on PR #4080 :)
#12
@
22 months ago
Thanks, @audrasjb and @dhrupo. There are a lot of file changes. I checked these files, and everything looks better.
@audrasjb commented on PR #4081:
22 months ago
#13
Closing in favor of #4080
#14
@
22 months ago
- Keywords has-unit-tests removed
In PR4080:
- Replace
/support/article/
with/documentation/article/
for links to HelpHub docs - Replace
/support/
with/support/forums/
for links to Support forums, and update the link anchor to replace "Support" with "Support forums" for disambiguation
#16
@
22 months ago
I ran the 117 URLs from PR 4080 through Screaming Frog SEO to find any redirects or errors.
Spreadsheet with redirecting and error URLs, plus suggestions
The Twenty Twenty-Three changelog seems to be missing, and 28 of the proposed /documentation/
URLs still redirect to another URL.
- The changelog links for Twenty Twenty-One and Twenty Twenty-Two need the slash character before the hash. Also, some of the anchors on those changelog pages simply do not follow the original pattern; others are wrong.
- Documentation on Using Themes redirects to https://wordpress.org/documentation/article/worik-with-themes/, which has a typo in the URL.
- Documentation on Writing and Editing Posts redirects to https://wordpress.org/documentation/article/wordpress-block-editor/, but
edit-form-advanced
is for the Classic Editor. - The other redirects seem appropriate.
#18
@
22 months ago
OK, for better tracking, I'll first commit the replacement of /support/article/
with /documentation/article/
, then I'll change the redirected URL you listed in your spreadsheet, @sabernhardt so it's easier to understand the purpose of each changeset.
@audrasjb commented on PR #4080:
22 months ago
#21
#23
@
22 months ago
@sabernhardt [55414] should have addressed all the URL redirections you listed in your spreadsheet.
#27
follow-up:
↓ 28
@
22 months ago
- Keywords has-patch removed
Thanks!
Most of the Help section links are revised, though two were missed:
- [55414] changed the Customizer URL in Twenty Eleven, but it is also in
wp-admin/customize.php
. - The Documentation on Editing Themes link in
wp-admin/theme-editor.php
can be updated to https://wordpress.org/documentation/article/appearance-theme-file-editor-screen/
The changelog links have not been edited, but I think the documentation pages should be updated first.
I recommend reverting [55415] and discussing that on a separate ticket. The six multisite forum links are all directly below another link with title case, and the other five links probably should have "Support" lowercase if "forums" is.
#28
in reply to:
↑ 27
;
follow-up:
↓ 29
@
22 months ago
Thanks!
Replying to sabernhardt:
- [55414] changed the Customizer URL in Twenty Eleven, but it is also in
wp-admin/customize.php
.- The Documentation on Editing Themes link in
wp-admin/theme-editor.php
can be updated to https://wordpress.org/documentation/article/appearance-theme-file-editor-screen/
Ok, will do.
The changelog links have not been edited, but I think the documentation pages should be updated first.
Yep, agreed.
I recommend reverting [55415] and discussing that on a separate ticket. The six multisite forum links are all directly below another link with title case, and the other five links probably should have "Support" lowercase if "forums" is.
Ok, I'd suggest to partially revert [55415]:
- Revert the change in the six multisite forum links
- Lowercase "Support" on other links
What do you think @sabernhardt?
#29
in reply to:
↑ 28
@
22 months ago
- Revert the change in the six multisite forum links
- Lowercase "Support" on other links
A partial revert like that is fine with me, though I would also suggest adding commas to two of those three unique strings (which probably does not belong on this ticket).
/wp-includes/class-wpdb.php
:
'If you do not know how to set up a database, you should <strong>contact your host</strong>. If all else fails, you may find help at the <a href="%s">WordPress support forums</a>.'
/wp-includes/load.php
and twice in /wp-includes/class-wpdb.php
:
'If you are unsure what these terms mean, you should probably contact your host. If you still need help, you can always visit the <a href="%s">WordPress support forums</a>.'
/wp-content/themes/twentytwentyone/inc/starter-content.php
:
'Check out the support forums'
#30
@
22 months ago
- Keywords needs-patch added
I found other "Support forums" links under title case links, too, so the multisite forum links probably should remain the same as those (not reverting the change). However, the other three strings modified in [55415] might be edited further by tomorrow, with or without the commas. We would need a patch for that plus the Customizer and Theme documentation links (comment:27).
The changelog URLs still could be updated in a separate commit before RC1 (coordinated with #57689).
This ticket was mentioned in PR #4138 on WordPress/wordpress-develop by @sabernhardt.
22 months ago
#31
- Keywords has-patch added; needs-patch removed
- Updates Customizer and Theme documentation links to eliminate a redirect.
- Uses lowercase "support" in forum links (Twenty Twenty-One starter content,
wp-includes/class-wpdb.php
andwp-includes/load.php
). - Adds commas in the sentences for
wp-includes/class-wpdb.php
andwp-includes/load.php
.
I agree we should indeed try to target this for 6.2, and it sounds even more legit as it can be considered as a bug (and focused on Docs).