The UPGRADE.txt inside core says:

Sometimes an update includes changes to default.settings.php (this will be
   noted in the release notes). If that's the case, follow these steps:

However, CHANGELOG.txt is a very "big version" specific and does not have version by version changes.

A non-intuitive, hard to find link in the right bottom corner of https://www.drupal.org/project/drupal led me to https://www.drupal.org/list-changes/drupal, so I am checking there now.

Can be this somehow enhanced?

Comments

cilefen’s picture

Title: No accurate release notes » CHANGELOG.txt does not contain all changes from the release notes and change records
Category: Task » Bug report
Priority: Major » Normal
Issue tags: -release notes

The changelog is not the same as the release notes.

cilefen’s picture

Version: 8.0.0-beta12 » 8.0.x-dev
jhodgdon’s picture

Title: CHANGELOG.txt does not contain all changes from the release notes and change records » UPGRADE.txt should explain where to find release notes
Issue tags: -Documentation +Novice

Well, 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.

jhodgdon’s picture

Here's the issue I filed to fix those links by the way. Who knows when/if it will be addressed.

thejacer87’s picture

StatusFileSize
new642 bytes

Here'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!!! :)

thejacer87’s picture

Status: Active » Needs review
JulieHH’s picture

The URL pattern proposed in the patch works for Drupal 6 and 7 release notes but not currently for the Drupal 8 one.

thejacer87’s picture

Ya, I figured that the same URL pattern would apply once D8 is released. Is that the case?

jhodgdon’s picture

Status: Needs review » Needs work

Thanks 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!

thejacer87’s picture

StatusFileSize
new867 bytes
new1.35 KB

Cleaned up the spaces and updated the instructions.

jhodgdon’s picture

Looks pretty good, thanks!

+++ b/core/UPGRADE.txt
@@ -80,6 +80,12 @@ following the instructions in the INTRODUCTION section at the top of this file:
+     releases' link. From this page you can scroll down or use the filter to find
+     your version and its release notes.

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!

pushpinderchauhan’s picture

Status: Needs work » Needs review
StatusFileSize
new917 bytes
new1.07 KB
jhodgdon’s picture

Status: Needs review » Needs work

Much better, thanks!

+++ b/core/UPGRADE.txt
@@ -80,6 +80,13 @@ following the instructions in the INTRODUCTION section at the top of this file:
+     "Downloads" follow your version of Drupal to view the release notes. If

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"?

pushpinderchauhan’s picture

Status: Needs work » Needs review
StatusFileSize
new927 bytes
new1.02 KB

Thanks jhodgdon!
Please review the updated patch.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks! Looks good to me.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Docs are not frozen in beta. Committed 515e6fb and pushed to 8.0.x. Thanks!

  • alexpott committed 515e6fb on
    Issue #2516842 by er.pushpinderrana, thejacer87, jhodgdon: UPGRADE.txt...
David_Rothstein’s picture

Version: 8.0.x-dev » 7.x-dev
Status: Fixed » Patch (to be ported)
Issue tags: +Needs backport to D7

This 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?

jhodgdon’s picture

Actually 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.

pushpinderchauhan’s picture

Status: Patch (to be ported) » Needs review
StatusFileSize
new937 bytes

D7 patch as per #19 suggestion.

jhodgdon’s picture

Version: 7.x-dev » 8.0.x-dev
Status: Needs review » Needs work

OK we'd better go back to D8 and fix the indentation before we fix D7 the same (incorrect) way...

pushpinderchauhan’s picture

Status: Needs work » Needs review
StatusFileSize
new1.26 KB

D8 Patch.

jhodgdon’s picture

Version: 8.0.x-dev » 7.x-dev
Status: Needs review » Needs work

Thank 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!

  • jhodgdon committed a8eab69 on 8.0.x
    Issue #2516842 by er.pushpinderrana, jhodgdon: Fix indentation in...
pushpinderchauhan’s picture

Status: Needs work » Needs review
StatusFileSize
new931 bytes

Thanks so much jhodgdon!

Indentation fix has been applied to the attached patch. Please review.

jhodgdon’s picture

Status: Needs review » Needs work

Great, thanks! The indentation looks right here. I think we need a blank line before the paragraph though?

pushpinderchauhan’s picture

Status: Needs work » Needs review
StatusFileSize
new890 bytes
new599 bytes
jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Thanks!

David_Rothstein’s picture

Status: Reviewed & tested by the community » Fixed

Committed to 7.x - thanks!

  • David_Rothstein committed d2dd30f on 7.x
    Issue #2516842 by er.pushpinderrana, thejacer87, jhodgdon: UPGRADE.txt...

Status: Fixed » Closed (fixed)

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