The hook_help() implementations in modules in D7/8 have a standard format that, at the end, points the user to the on-line help page. When they were first written, these URLs were http://drupal.org/handbook/modules/[module short name]. But the URLs for these pages changed a while back to http://drupal.org/documentation/modules/[module short name]. They all need to be updated in the Drupal Core code.

For instance, in taxonomy.module:

$output .= '<p>' . t('The Taxonomy module allows you to classify the content of your website. To classify content, you define <em>vocabularies</em> that contain related <em>terms</em>, and then assign the vocabularies to content types. For more information, see the online handbook entry for the <a href="@taxonomy">Taxonomy module</a>.', array('@taxonomy' => 'http://drupal.org/handbook/modules/taxonomy/')) . '</p>';

Just that final URL needs to be fixed, and it doesn't affect the string that the translation people use.

So, this should be a good Novice task. In summary:

Find all places where there is a URL like http://drupal.org/handbook[with any suffix] in the Drupal code base, and replace it with http://drupal.org/documentation[same suffix]. As a bonus, verify that the new URLs all work and go to the desired documentation page on Drupal.org.

CommentFileSizeAuthor
#8 Update-do-urls-1483662-d7-8.patch73.84 KBrdickert
#5 Update-do-urls-1483662-5.patch72.03 KBPsikik
#3 1483662-2.patch62.2 KBPsikik
#1 1483662-1.patch61.89 KBPsikik

Comments

Psikik’s picture

Psikik commented
Status: Active » Needs review
StatusFileSize
new 1483662-1.patch61.89 KB

Here's a first go at patch. A few of the links had trailing slashes, I removed them to bring them in line with the majority of the links.

For the Entity and Language modules there are no documentation/modules pages.

For the Field UI module, the help text says "see the online handbook entry for Field module." The link actually points to a handbook for the Field UI.

There are a couple of places that reference http://drupal.org/handbooks should this be changed to http://drupal.org/documentation?

All of the help entries refer to the pages as online handbooks, should this be changed to online documentation?

In the php_help(), there's a link to http://drupal.org/handbook/customization/php-snippets. This redirects to http://drupal.org/documentation/customization/php-snippets. Should I replace it?

Status: Needs review » Needs work

The last submitted patch, 1483662-1.patch, failed testing.

Psikik’s picture

Psikik commented
Status: Needs work » Needs review
StatusFileSize
new 1483662-2.patch62.2 KB

Made that patch from the wrong directory. Re-uploading.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Thanks Psikik! To answer your questions in (1):
- entity/language - new modules for Drupal 8, which is why they don't have pages yet. Go ahead and leave the URLs there though, following the other patterns.
- Field UI - sounds like a good thing to catch/fix, thanks!
- Yes, any old references to http://drupal.org/handbooks should be changed to http://drupal.org/documentation. Actually, any references to d.o/handbooks/* got changed to d.o/documentation/[same page] when we changed the URLs, with redirects. Which explains the http://drupal.org/handbook/customization/php-snippets -> http://drupal.org/documentation/customization/php-snippets that you found.
- I don't think it's so bad to call something "the online handbook for the XYZ module", so we can leave that.

I think that answers everything... Let me know if you have more questions. Thanks for being so careful!

Psikik’s picture

Psikik commented
StatusFileSize
new Update-do-urls-1483662-5.patch72.03 KB

Here's an updated patch with all the changes in #4.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Looks great! Thanks!

This should also be good to go for Drupal 7, plus or minus a context reroll. It does not affect any of the translated strings, only the URLs substituted into them.

catch’s picture

catch
he/him
Primary language English
commented
Version: 8.x-dev » 7.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

Looks good to me, committed/pushed to 8.x, moving back to 7.x to be ported.

rdickert’s picture

rdickert commented
Status: Patch (to be ported) » Needs review
StatusFileSize
new Update-do-urls-1483662-d7-8.patch73.84 KB

This is the backport to D7. ColoradoChris and rdickert worked together on this.

Did a global search and replace on all files and replaced drupal.org/handbook with drupal.org/documentation

Files in 8.x not 7.x:
entity
help.test
language

Files in 7.x not 8.x:
blog
profile
trigger

webkenny’s picture

webkenny commented
Status: Needs review » Reviewed & tested by the community

Looks good to me. Applies fine and does the job. Marking RTBC.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Looks good! I was briefly concerned with this from hook_library() implementation in overlay.module:

@@ -202,7 +202,7 @@ function overlay_library() {
   // Overlay parent.
   $libraries['parent'] = array(
     'title' => 'Overlay: Parent',
-    'website' => 'http://drupal.org/handbook/modules/overlay',
+    'website' => 'http://drupal.org/documentation/modules/overlay',
     'version' => '1.0',
     'js' => array(
       $module_path . '/overlay-parent.js' => array(),
@@ -218,7 +218,7 @@ function overlay_library() {
   // Overlay child.
   $libraries['child'] = array(
     'title' => 'Overlay: Child',
-    'website' => 'http://drupal.org/handbook/modules/overlay',
+    'website' => 'http://drupal.org/documentation/modules/overlay',
     'version' => '1.0',
     'js' => array(
       $module_path . '/overlay-child.js' => array(),

But I think this is OK, since the 'website' parameter is not translated to my knowledge. +1 on RTBC; leaving for webchick to commit since it is not technically just documentation.

webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
commented

FWIW, I am totally fine you committing patches like this.

The earliest I'll be able to review this myself will be sometime after the 7.13 release (maybe Thursday/Friday)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x. Thanks all! Another "major" fixed. :)

Automatically closed -- issue fixed for 2 weeks with no activity.