Opened 5 years ago
Closed 22 months ago
#48987 closed task (blessed) (fixed)
Replace Codex links with their HelpHub counterparts (take 2)
Reported by: | netweb | Owned by: | SergeyBiryukov |
---|---|---|---|
Milestone: | 6.2 | Priority: | normal |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
Follow up to #47771 for WP 5.4 via @casiepa in meta:ticket:4907
Now that the new HelpHub is getting up to speed, it would probably be good to grep for all links to Codex in core?
At a glance, most Codex links used in core do indeed redirect to their HelpHub counterparts now, for example:
https://translate.wordpress.org links:
Links:
- https://codex.wordpress.org/
- https://codex.wordpress.org/Appearance_Background_Screen
- https://codex.wordpress.org/Appearance_Header_Screen
- https://codex.wordpress.org/CSS
- https://codex.wordpress.org/Dashboard_My_Sites_Screen
- https://codex.wordpress.org/Excerpt
- https://codex.wordpress.org/Function_Reference/is_main_query
- https://codex.wordpress.org/Links_Add_New_Screen
- https://codex.wordpress.org/Links_Link_Categories_Screen
- https://codex.wordpress.org/Links_Screen
- https://codex.wordpress.org/Network_Admin_Settings_Screen
- https://codex.wordpress.org/Network_Admin_Themes_Screen
- https://codex.wordpress.org/Network_Admin_Users_Screen
- https://codex.wordpress.org/Update_Services
Let's update all the Codex URLs in core and bundled themes to link to the corresponding HelpHub articles.
Attachments (2)
Change History (50)
This ticket was mentioned in Slack in #core by david.baumwald. View the logs.
5 years ago
This ticket was mentioned in Slack in #docs by marcio-zebedeu. View the logs.
5 years ago
#6
@
5 years 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
@
5 years 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
@
5 years 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
@
4 years 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 (whoch shows https://developer.wordpress.org/reference/classes/wpdb/ as new location)
In wp-includes/functions.php
I found https://codex.wordpress.org/File_Header
#10
@
4 years 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
@
4 years ago
- Summary changed from Replace Codex links with their HelpHub counterparts to Replace Codex links with their HelpHub counterparts (take 2)
#12
@
4 years 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 basis.
These can be safely replaced, as they either already redirect or have a full equivalent:
https://codex.wordpress.org/Excerpt(already replaced in [45674])- https://codex.wordpress.org/IRC
- https://codex.wordpress.org/Network_Admin_Settings_Screen
- https://codex.wordpress.org/Update_Services
- https://codex.wordpress.org/Function_Reference/is_main_query
- https://codex.wordpress.org/Function_Reference/wpdb_Class
#14
follow-up:
↓ 17
@
4 years 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 :
- https://codex.wordpress.org/Appearance_Background_Screen => https://wordpress.org/support/article/appearance-customize-screen/ (/wp-admin/includes/class-custom-background.php)
- https://codex.wordpress.org/Dashboard_My_Sites_Screen => https://wordpress.org/support/article/network-admin-sites-screen/ (/wp-admin/my-sites.php)
Here is a patch which fix these two links.
#15
@
4 years 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.
4 years ago
#17
in reply to:
↑ 14
@
4 years 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 :
- https://codex.wordpress.org/Appearance_Background_Screen => https://wordpress.org/support/article/appearance-customize-screen/ (/wp-admin/includes/class-custom-background.php)
- https://codex.wordpress.org/Dashboard_My_Sites_Screen => https://wordpress.org/support/article/network-admin-sites-screen/ (/wp-admin/my-sites.php)
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.
This ticket was mentioned in Slack in #core by hellofromtonya. View the logs.
4 years ago
#20
@
4 years ago
There's a prominent mention of Codex in /readme.html:
<dt><a href="https://codex.wordpress.org/">The WordPress Codex</a></dt> <dd>The Codex is the encyclopedia of all things WordPress. It is the most comprehensive source of information for WordPress available.</dd>
It would be good to fix that both for trunk and 5.7.x
This ticket was mentioned in PR #2707 on WordPress/wordpress-develop by audrasjb.
3 years ago
#22
Trac ticket: https://core.trac.wordpress.org/ticket/48987
#23
follow-up:
↓ 25
@
3 years ago
Nice finding @netweb. The above PR fixes the issue. Does the proposed wording sounds better to you?
#25
in reply to:
↑ 23
@
3 years ago
Replying to audrasjb:
Nice finding @netweb. The above PR fixes the issue. Does the proposed wording sounds better to you?
That was @tobifjellner's comment :)
#27
@
2 years ago
This ticket was mentioned in PR #2707 on WordPress/wordpress-develop by audrasjb.
https://github.com/WordPress/wordpress-develop/pull/2707
Approved, good to commit
This ticket was mentioned in Slack in #core by audrasjb. View the logs.
2 years ago
2 years ago
#31
Committed in https://core.trac.wordpress.org/changeset/54189
This ticket was mentioned in PR #3282 on WordPress/wordpress-develop by audrasjb.
2 years ago
#32
Trac ticket: https://core.trac.wordpress.org/ticket/48987
#33
@
2 years ago
The above PR (2707) refreshes @Chaton666's previous PR to only take into account the My Sites screen.
2 years ago
#35
Committed in https://core.trac.wordpress.org/changeset/54225
#36
@
2 years ago
I don't think [54225] is correct. As noted in comment:17:
Dashboard My Sites Screen is about the My Sites screen, not about the Network Admin Sites Screen.
These are different screens, so one link is not a replacement for the other. As far as I can tell, there is no replacement for the former link at this time.
#37
@
2 years ago
Errr… I didn't understand your comment correctly :(
You're definitely right @SergeyBiryukov. I'll revert this changeset accordingly.
I'll also suggest a new HelpHub page for this screen.
#39
@
2 years ago
- Type changed from enhancement to task (blessed)
Let's convert this to a task, instead of an enhancement.
This ticket was mentioned in Slack in #core by chaion07. View the logs.
2 years ago
#41
@
2 years ago
- Milestone changed from 6.1 to 6.2
With WP 6.1 RC 1 scheduled tomorrow (Oct 10, 2022), there is not much time left to address this ticket. Let's move it to the next milestone.
Ps: if you were about to send a patch and if you feel it is realistic to commit it in the next few hours, please feel free to move this ticket back to milestone 6.1.
This ticket was mentioned in Slack in #core by costdev. View the logs.
22 months ago
#43
@
22 months ago
@audrasjb is this page Documentation on My Sites ready to use 6.2 or not? If not we can improve the content. @SergeyBiryukov what's your opinion, could you please check?
#44
follow-up:
↓ 45
@
22 months ago
@rudlinkon not sure I understand well your question, but as far as I know this HelpHub article is already linked in /wp-admin/network/sites.php
help tab.
#45
in reply to:
↑ 44
@
22 months ago
Replying to audrasjb:
@rudlinkon not sure I understand well your question, but as far as I know this HelpHub article is already linked in
/wp-admin/network/sites.php
help tab.
Thank you @audrasjb for your quick reply so I think we can close this ticket, what do you think @SergeyBiryukov?
#47
@
22 months ago
Looking at the remaining Codex URLs in core, it appears that most of them still don't have a corresponding HelpHub article at this time:
- https://codex.wordpress.org/AJAX_in_Plugins
- This one can probably be replaced with https://developer.wordpress.org/plugins/javascript/ajax/.
- https://codex.wordpress.org/Links_Add_New_Screen
- https://codex.wordpress.org/Links_Link_Categories_Screen
- https://codex.wordpress.org/Links_Screen
- https://codex.wordpress.org/Dashboard_My_Sites_Screen
- https://codex.wordpress.org/Appearance_Background_Screen
- https://codex.wordpress.org/Appearance_Header_Screen
- https://codex.wordpress.org/Network_Admin_Themes_Screen
- https://codex.wordpress.org/Network_Admin_Users_Screen
- https://codex.wordpress.org/Right_to_Left_Language_Support
- https://codex.wordpress.org/Post_Thumbnails#Setting_a_Post_Thumbnail
- https://codex.wordpress.org/Twenty_Fourteen
- https://codex.wordpress.org/Creating_an_Error_404_Page
- https://codex.wordpress.org/Theme_Logo
- https://codex.wordpress.org/Custom_Headers
- https://codex.wordpress.org/Author_Templates
- https://codex.wordpress.org/File_Header
Updating these links would need some coordination with the Documentation team, probably as part of the effort to redirect all remaining pages to HelpHub in #meta5861.
I think this ticket can be closed for now, and we can do another audit in a future release.
On a related note, see #57726 for updating HelpHub links to use the new /documentation/
URLs.
@netweb That sounds about right. I can patch it up.