Make WordPress Core

Opened 13 months ago

Closed 12 months ago

Last modified 11 months ago

#57726 closed defect (bug) (fixed)

Use the new /documentation/ URLs for HelpHub links

Reported by: sergeybiryukov's profile SergeyBiryukov Owned by: audrasjb's profile 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:

  1. All /support/article/* URLs should be redirected to /documentation/article/* to avoid an extra redirect.
  2. 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)

#1 @audrasjb
13 months ago

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).

#2 follow-up: @audrasjb
13 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 @audrasjb
13 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.


13 months ago
#4

  • Keywords has-patch has-unit-tests added

#5 in reply to: ↑ 2 ; follow-up: @SergeyBiryukov
13 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 now is https://wordpress.org/support/forums/.

https://wordpress.org/support/ just redirects to https://wordpress.org/documentation/ :)

Version 0, edited 13 months ago by SergeyBiryukov (next)

#6 in reply to: ↑ 5 @SergeyBiryukov
13 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".

#7 @audrasjb
13 months ago

Yes, exactly :)

This ticket was mentioned in PR #4081 on WordPress/wordpress-develop by @dhrupo.


13 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 @dhrupo
13 months ago

@audrasjb @SergeyBiryukov hi there,

I have updated all of the code in all PHP files as

  1. /support/article/* to /documentation/article/*
  2. /support/ to /support/forums

Please check and let me know

Last edited 13 months ago by dhrupo (previous) (diff)

@audrasjb commented on PR #4081:


13 months ago
#10

Thanks for the PR, however I'm already working on PR #4080 :)

#11 @hasanmisbah
13 months ago

PR Looks good. thanks @dhrupo

#12 @sakibmd
13 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:


13 months ago
#13

Closing in favor of #4080

#14 @audrasjb
13 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

#15 @audrasjb
13 months ago

  • Component changed from General to Help/About

#16 @sabernhardt
12 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.

#17 @audrasjb
12 months ago

Thanks for checking this @sabernhardt! I'll update the PR accordingly.

#18 @audrasjb
12 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.

#19 @audrasjb
12 months ago

In 55412:

Help/About: Use the new /documentation/ URLs for HelpHub links in WordPress Admin.

As https://wordpress.org/support/ was redirected to https://wordpress.org/documentation/, this changeset replaces various /support/article/* links with /documentation/article/* to avoid an extra redirect.

This also updates links to Support Forums by replacing https://wordpress.org/support/ URLs with https://wordpress.org/support/forums/.

Props SergeyBiryukov, audrasjb, dhrupo, hasanmisbah, sakibmd, sabernhardt.
See #57726.

#20 @audrasjb
12 months ago

In 55413:

Help/About: Use the new /documentation/ URLs for HelpHub links in Bundled Themes.

As https://wordpress.org/support/ was redirected to https://wordpress.org/documentation/, this changeset replaces various /support/article/* links with /documentation/article/* to avoid an extra redirect.

This also updates links to Support Forums by replacing https://wordpress.org/support/ URLs with https://wordpress.org/support/forums/.

Props SergeyBiryukov, audrasjb, dhrupo, hasanmisbah, sakibmd, sabernhardt.
See #57726.

#22 @audrasjb
12 months ago

In 55414:

Help/About: Avoid extra redirections on HelpHub Links.

This changeset replaces various HelpHub links that have changed to avoid extra 301 redirections.

Props sabernhardt, audrasjb.
See #57726.

#23 @audrasjb
12 months ago

@sabernhardt [55414] should have addressed all the URL redirections you listed in your spreadsheet.

#24 @audrasjb
12 months ago

In 55415:

Help/About: Use a consistent capitalization for "Support forums" links across WP Admin.

Follow-up to [55412], [55413].

See #57726.

#25 @audrasjb
12 months ago

@sabernhardt anything I missed?

#26 @SergeyBiryukov
12 months ago

In 55416:

Toolbar: Update the URL for Documentation link in the admin bar.

This avoids an extra redirect from https://wordpress.org/support/ to https://wordpress.org/documentation/.

Follow-up to [55412], [55413], [55414], [55415].

See #57726.

#27 follow-up: @sabernhardt
12 months ago

  • Keywords has-patch removed

Thanks!

Most of the Help section links are revised, though two were missed:

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: @audrasjb
12 months ago

Thanks!

Replying to sabernhardt:

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 @sabernhardt
12 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 @sabernhardt
12 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). Already done in [55413].

Last edited 12 months ago by sabernhardt (previous) (diff)

This ticket was mentioned in PR #4138 on WordPress/wordpress-develop by @sabernhardt.


12 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 and wp-includes/load.php).
  • Adds commas in the sentences for wp-includes/class-wpdb.php and wp-includes/load.php.

Trac 57726

#32 @audrasjb
12 months ago

In 55431:

Help/About: Use a consistent capitalization for "Support forums" links across WP Admin.

This partially reverts [55415] and fix a few inconsistencies found in "support forums" links.

Follow-up to [55412], [55413], [55415].

Props sabernhardt, audrasjb.
See #57726.

#33 @audrasjb
12 months ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 55432:

Help/About: Avoid extra redirections on HelpHub Links.

This changeset replaces various HelpHub links that have changed to avoid extra 301 redirections.

Follow-up to [55412], [55413], [55414], [55415], [55416], [55431].

Props sabernhardt, audrasjb.
Fixes #57726.

#35 @SergeyBiryukov
12 months ago

In 55434:

Help/About: Restore the correct URL for Editing Files article on Edit Themes screen.

Replace the URL for Editing Themes article instead to avoid an extra redirect.

Follow-up to [55432].

See #57726.

#36 @SergeyBiryukov
12 months ago

In 55461:

Docs: Use the new /documentation/ URL for HelpHub link in readme.html.

Follow-up to [55412], [55413], [55414], [55415], [55416], [55431], [55432], [55434].

See #57726.

#37 @desrosj
12 months ago

In 55478:

Bundled Themes: Add missing trailing / in HelpHub links.

HelpHub links without trailing slashes with anchors present result in an unnecessary redirect.

These were introduced with the / missing in [55476].

Props audrasjb.
See #57689, #57726.

#38 @audrasjb
11 months ago

In 55624:

Help/About: Use the new /documentation/ URLs for links about WordPress version.

As https://wordpress.org/support/ was redirected to https://wordpress.org/documentation/, this changeset replaces various /support/* links with /documentation/* to avoid extra redirects.

Follow-up to [55412], [55413], [55414].

Props wildworks.
See #58052, #57726.

#39 @audrasjb
11 months ago

In 55625:

Help/About: Use the new /documentation/ URLs for links about WordPress version.

As https://wordpress.org/support/ was redirected to https://wordpress.org/documentation/, this changeset replaces various /support/* links with /documentation/* to avoid extra redirects. This addresses a missed occurrence from [55624].

Follow-up to [55412], [55413], [55414], [55624].

Props wildworks.
See #58052, #57726.

#40 @audrasjb
11 months ago

In 55626:

Help/About: Use the new /documentation/ URLs in options-permalink.php.

As https://wordpress.org/support/ was redirected to https://wordpress.org/documentation/, this changeset replaces various /support/* links with /documentation/* to avoid extra redirects.

Follow-up to [55412], [55413], [55414], [55624], [55625].

Props sabernhardt, audrasjb.
See #58052, #57726.

#41 @audrasjb
11 months ago

In 55627:

Help/About: Fix the Support Forums URL in wp-admin/includes/class-wp-site-health.php.

This updates a link to Support Forums by replacing https://wordpress.org/support/ URL with https://wordpress.org/support/forums/.

Follow-up to [55412], [55413], [55414], [55624], [55625], [55626].

Props sabernhardt, audrasjb.
See #58052, #57726.

Note: See TracTickets for help on using tickets.