Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Unassigned
Issue tags:
Reporter:
Created:
1 Jul 2015 at 18:56 UTC
Updated:
28 Oct 2015 at 22:04 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
cilefen commentedThe changelog is not the same as the release notes.
Comment #2
cilefen commentedComment #3
jhodgdonWell, it sounds like this user was confused about the difference between CHANGELOG, the list-changes page (with all the change records), and the Release Notes.
It seems like we should fix UPDATE.txt to explain where to find the release notes. This is NOT obvious at all, really...
So if you go to
https://www.drupal.org/project/drupal
and download a Drupal version, you can read the release notes by clicking on the link that the version number makes. So for instance if you click on the 7.38 there, instead of actually downloading 7.38 (which you might expect), you get the notes page.
We should also fix that by the way. Those links are not accessible for one thing. I will file an issue in Project * about that. But meanwhile, we should document it in UPDATE.txt.
Comment #4
jhodgdonHere's the issue I filed to fix those links by the way. Who knows when/if it will be addressed.
Comment #5
thejacer87 commentedHere's the patch. I said to go to https://www.drupal.org/drupal-x.xx-release-notes. Seemed to get too wordy top tell them to go to https://www.drupal.org/project/drupal and click the link for their version. Also, it seems like only the current 7.x and 6.x releases are there. So it might not be the right version for someone.
Anyway, this is my FIRST patch, so don't go easy on me!!! :)
Comment #6
thejacer87 commentedComment #7
JulieHH commentedThe URL pattern proposed in the patch works for Drupal 6 and 7 release notes but not currently for the Drupal 8 one.
Comment #8
thejacer87 commentedYa, I figured that the same URL pattern would apply once D8 is released. Is that the case?
Comment #9
jhodgdonThanks for the patch and reviews!
I am not sure about the URL pattern for Drupal 8. As far as I know, it is not automatically generated, and Drupal 8 will have longer version numbers like 8.0.0 anyway.... So I think the wordy "go here and click there" is safer.
Also, regarding the patch -- there are lines with spaces at the end of them. Please remove them. Most code editors can be set up to either highlight or remove end-of-space lines; if you plan to keep making patches for Drupal, you'll want to find that setting. Thanks!
Comment #10
thejacer87 commentedCleaned up the spaces and updated the instructions.
Comment #11
jhodgdonLooks pretty good, thanks!
We want all lines to wrap at 80 characters, and this goes over by 1.
Other than that, I think this looks good...
Well maybe we should mention that all of this is down at the bottom of the project page under "Downloads"?
And I'm wondering if "Click on your version of Drupal" is clear enough... can it be reworded somehow, also taking into account that not everyone actually "clicks" on a link (that is only for people who use a mouse)? (maybe say "use" a link or "follow" a link?)
Also, going forward: when you upload a patch, also set the issue to "Needs review" to alert us that there is something new to review. Thanks!
Comment #12
pushpinderchauhan commentedComment #13
jhodgdonMuch better, thanks!
Hm. Let's say "use the link for your version of Drupal" instead of "follow"? I don't think "follow your version of Drupal" makes sense without the word "link"?
Comment #14
pushpinderchauhan commentedThanks jhodgdon!
Please review the updated patch.
Comment #15
jhodgdonThanks! Looks good to me.
Comment #16
alexpottDocs are not frozen in beta. Committed 515e6fb and pushed to 8.0.x. Thanks!
Comment #18
David_Rothstein commentedThis is worth backporting.
A minor fix needed for Drupal 8, though (could be a separate followup issue) - shouldn't this have a "-" at the beginning because it's a separate point in the bulleted list?
Comment #19
jhodgdonActually I think it should be un-indented by 2 spaces because it is not a step (like the other bullet points), it is just a comment explaining where to find the release notes (they are mentioned before that bullet list). Good catch though.
Comment #20
pushpinderchauhan commentedD7 patch as per #19 suggestion.
Comment #21
jhodgdonOK we'd better go back to D8 and fix the indentation before we fix D7 the same (incorrect) way...
Comment #22
pushpinderchauhan commentedD8 Patch.
Comment #23
jhodgdonThank you. As this is just an indentation fix, I went ahead and committed it to D8... although the indentation was not quite right still, but I adjusted it on commit. Now we just need to get the D7 patch indented correctly. It should be indented the same as the other paragraphs above the - bullet list.
Thanks!
Comment #25
pushpinderchauhan commentedThanks so much jhodgdon!
Indentation fix has been applied to the attached patch. Please review.
Comment #26
jhodgdonGreat, thanks! The indentation looks right here. I think we need a blank line before the paragraph though?
Comment #27
pushpinderchauhan commentedComment #28
jhodgdonThanks!
Comment #29
David_Rothstein commentedCommitted to 7.x - thanks!