WordPress.org

Make WordPress Core

Opened 15 months ago

Last modified 2 weeks ago

#48987 accepted enhancement

Replace Codex links with their HelpHub counterparts (take 2)

Reported by: netweb Owned by: SergeyBiryukov
Milestone: Future Release Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Attachments (2)

48987.diff (2.3 KB) - added by Marcio Zebedeu 13 months ago.
48987.2.diff (1.4 KB) - added by Chaton666 2 weeks ago.

Download all attachments as: .zip

Change History (19)

#1 @Marcio Zebedeu
14 months ago

@netweb That sounds about right. I can patch it up.

This ticket was mentioned in Slack in #core by david.baumwald. View the logs.


13 months ago

#3 @davidbaumwald
13 months ago

@marcio-zebedeu Are you still working on a patch for this to include in 5.4?

This ticket was mentioned in Slack in #docs by marcio-zebedeu. View the logs.


13 months ago

#5 @Marcio Zebedeu
13 months ago

@davidbaumwald go to work now and send that in an hour.

#6 @Marcio Zebedeu
13 months ago

  • Keywords has-patch dev-feedback added; good-first-bug removed

I added the patch but so it doesn't cover all the links presented.

Therefore, the following codex links do not have their corresponding links in helphub:
https://codex.wordpress.org/CSS
https://codex.wordpress.org/Network_Admin_Settings_Screen
https://codex.wordpress.org/Network_Admin_Themes_Screen
https://codex.wordpress.org/Network_Admin_Users_Screen

As for the following links, they would need feedback to know if they would be removed or kept as it is still possible to activate the Links and Link categories:

https://codex.wordpress.org/Links_Add_New_Screen
https://codex.wordpress.org/Links_Link_Categories_Screen
https://codex.wordpress.org/Links_Screen

#7 @Marcio Zebedeu
13 months ago

the person responsible for the migration is already fixing the pages that have not yet been migrated. Then then I can modify patch

#8 @davidbaumwald
13 months ago

  • Milestone changed from 5.4 to Future Release

This ticket still needs a resolution, and with 5.4 Beta 1 landing tomorrow, this is being moved to Future Release. If any maintainer or committer feels this can be included in 5.4 or wishes to assume ownership during a specific cycle, feel free to update the milestone accordingly.

#9 @zodiac1978
2 months ago

Not sure if those pages will be moved too, so I just mention the ones i found additionally:

In the readme.txt files of the default bundled themes there are links to the codex too.
https://codex.wordpress.org/Twenty_Thirteen (and all the other Twenty* themes)
and their changelog pages, like https://codex.wordpress.org/Twenty_Fifteen_Theme_Changelog

In some of the default themes is a 404.php file linking to https://codex.wordpress.org/Creating_an_Error_404_Page

In wp-includes/cache-compat.php and wp-includes/cache.php is a link to https://codex.wordpress.org/Class_Reference/WP_Object_Cache

In wp-content/themes/twentyfourteen/inc/customizer.php I found https://codex.wordpress.org/Post_Thumbnails#Setting_a_Post_Thumbnail

The readme.html links to https://codex.wordpress.org/IRC, although this redirects already to https://make.wordpress.org/support/handbook/appendix/other-support-locations/introduction-to-irc/

In wp-content/themes/twentyseventeen/inc/custom-header.php (and more) I found https://codex.wordpress.org/Custom_Headers

In wp-content/themes/twentytwelve/rtl.css (and more) I found https://codex.wordpress.org/Right_to_Left_Language_Support

In wp-admin/network/user-new.php and /wp-settings.php I found https://codex.wordpress.org/AJAX_in_Plugins

In wp-content/themes/twentynineteen/functions.php (and more) I found https://codex.wordpress.org/Theme_Logo

In wp-includes/author-template.php I found https://codex.wordpress.org/Author_Templates

In wp-includes/wp-db.php I found https://codex.wordpress.org/Function_Reference/wpdb_Class (which shows https://developer.wordpress.org/reference/classes/wpdb/ as new location)

In wp-includes/functions.php I found https://codex.wordpress.org/File_Header

Last edited 2 months ago by zodiac1978 (previous) (diff)

#10 @zodiac1978
2 months ago

@marcio-zebedeu I am not sure about <a href="https://codex.wordpress.org/Appearance_Header_Screen">Documentation on Custom Header</a> changing to <a href="https://wordpress.org/support/article/appearance-customize-screen">Documentation on Custom Header</a>

As this is only about the header image, wouldn't it be better to link to the correct section?
https://wordpress.org/support/article/appearance-customize-screen/#header-image

If there are no decisions made for new helphub pages the patch should at least include this one:

In wp-includes/wp-db.php I found https://codex.wordpress.org/Function_Reference/wpdb_Class (which shows https://developer.wordpress.org/reference/classes/wpdb/ as new location)

@SergeyBiryukov I think after these additions the patch could be a starting point and added to 5.7.

#11 @SergeyBiryukov
2 months ago

  • Summary changed from Replace Codex links with their HelpHub counterparts to Replace Codex links with their HelpHub counterparts (take 2)

#12 @SergeyBiryukov
2 months ago

  • Owner set to SergeyBiryukov
  • Status changed from new to accepted

Just noting that some of these links were previously considered in #47771 (comment 8, comment 11, comment 12), but either didn't have a suitable HelpHub or DevHub equivalent at the time, or the Codex pages had significantly more relevant information than the DevHub ones.

It looks like that is still the case for most links, however a few links have changed since then, so let's address them on a case-by-case basic.

These can be safely replaced, as they either already redirect or have a full equivalent:

Last edited 2 months ago by SergeyBiryukov (previous) (diff)

#13 @SergeyBiryukov
2 months ago

In 49912:

Docs: Second pass at replacing Codex URLs with a corresponding HelpHub or DevHub article.

Follow-up to [45674-45677].

Props marcio-zebedeu, zodiac1978, netweb.
See #48987.

#14 follow-up: @Chaton666
2 weeks ago

At the french team doc (@audrasjb, @jdy68) we have made some research to replace old codex links in the dashboard.
@jdy68 have made this doc which list links. Some of these are already updated.

There are still links that point to the old codex :

Here is a patch which fix these two links.

Last edited 2 weeks ago by Chaton666 (previous) (diff)

@Chaton666
2 weeks ago

#15 @audrasjb
2 weeks ago

  • Milestone changed from Future Release to 5.7

Thanks! Moving the ticket back to milestone 5.7

This ticket was mentioned in Slack in #core by audrasjb. View the logs.


2 weeks ago

#17 in reply to: ↑ 14 @SergeyBiryukov
2 weeks ago

  • Keywords dev-feedback removed
  • Milestone changed from 5.7 to Future Release

Replying to Chaton666:

There are still links that point to the old codex :

Thanks for the patch! However, as noted in comment:12, these links are not equivalent:

  • Appearance Background Screen is about the old Custom Background screen (visible in the screenshots there and still accessible via /wp-admin/themes.php?page=custom-background), not about the Customizer.
  • Dashboard My Sites Screen is about the My Sites screen, not about the Network Admin Sites screen.
Last edited 2 weeks ago by SergeyBiryukov (previous) (diff)
Note: See TracTickets for help on using tickets.