Closed (fixed)
Project:
Drupal core
Version:
8.0.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Reporter:
Created:
29 Apr 2012 at 00:00 UTC
Updated:
29 Jul 2014 at 20:39 UTC
Jump to comment: Most recent file
Comments
Comment #1
duellj commentedAnd here's the patch.
Comment #2
David_Rothstein commentedThis looks good, and I verified that all the URLs work as expected:
Would it be cleaner (and a bit more future-proof) to use http://api.drupal.org/api/group/ajax/8 here instead? It seems to go to the same place.
Comment #3
jhodgdon#2 - yes!
To point to the Form API reference, just use the file name forms_api_reference.html instead of the URL.
To point to a topic, just use the topic's machine name, such as "ajax", instead of the URL.
If there are any other places in core that have links to api.drupal.org, they should all be removed.
Comment #4
jhodgdonSorry, to clarify: #3 only applies to documentation headers. If there are links being made in Help, then they need to have the URL, and the URL suffix needs to have /8 on it to be "future-proof".
And for URLs with #suffix on them, I would reword so that the on-page reference isn't needed. Just say "See the @link forms_api_reference.html Form API reference @endlink for more information." or something like that.
Comment #5
duellj commentedThanks jhodgdon. All of the @links are to the forms_api_reference.html page, so updated all of those (and found a couple more that needed shortening). Also removed the #tree link and added the more generic see @link.
Comment #6
jhodgdonMostly good! A couple of things to fix:
a) In the first hunk in the patch, leave off the /8 -- just put in the file name:
Also, @link ... @endlink should always be all on one line. If that makes it go over 80 characters, start the @link on a new line.
b)
I think that @link...@endlink can be moved up to the previous line and not exceed 80 characters? If not, some of the words from the next line can be moved up.
c) It would be good if someone could check all the replaced URLs and make sure they all go to the correct place. Many of them redirect, which is probably OK (the URLs in the files are simpler than the ones they are redirected to), but someone should test them. I didn't do that yet.
Comment #7
duellj commentedThanks for the review jhodgdon. Fixed issues from #6, except for 'c', which I'm not sure how to check the URLs.
Comment #8
jhodgdon(c) - check the URLs == copy the URL from the patch, paste it into your browser's URL bar, and verify it goes to the correct function/class/topic documentation as intended. :)
Comment #9
duellj commentedOh, sorry, I thought you meant checking the short @link urls, which I wasn't sure how to do. I've checked all of the URLs in the patch, and they indeed to go to the correct topic intended by the documentation.
Comment #10
jhodgdonLooks good! This touches quite a few files, so I'll leave it at RTBC for a few days, and probably commit on Friday the 4th, if there are no issues tagged "avoid commit conflicts" that conflict at that time.
Comment #11
jhodgdonThanks! This has been committed to 8.x.