Steps 8 and 9 of upgrade.txt seem to be unclear and confusing. Here's how it reads now:

6. Remove all old files and directories from the Drupal installation directory.

7. Unpack the new files and directories into the Drupal installation directory.

8. Copy your backed up "files" and "sites" directories to the Drupal
installation directory. If other system files such as .htaccess or
robots.txt were customized, re-create the modifications in the new
versions of the files using the backups taken in step #1.

9. Verify the new configuration file to make sure it has correct information.

In step 8, it just says to copy the entire "sites" directory to the new installation without mentioning settings.php. In step 9, it says to verify the "new configuration file" but if I've followed step 8 correctly, I have a sites/default directory with an old settings.php file and a new default.settings.php file.

At this point I'm confused. Should I actually have copied the old settings.php file to the new sites/default? Or should there be a step to copy the default.settings.php file to settings.php and make the changes in the new settings.php.

Also in step 9 we should call it "sites/default/settings.php" rather than "the new configuration file". I know at the beginning we explain what the configuration file is, but its not obvious to the novice reader by the time they reach this point. We might also want to say something more specific like "Verify that sites/default/settings.php has the correct database connection information.".

CommentFileSizeAuthor
#6 UPGRADE.txt.patch10.97 KBLeeHunter
#5 UPGRADE.txt6.71 KBLeeHunter
#4 UPGRADE.txt6.58 KBLeeHunter
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

LeeHunter’s picture

Also I'm wondering whether it's actually necessary to restore the old modules before running update.php. This writer (http://becircle.com/how_upgrade_drupal_5_drupal_6_steps_3_and_4_actual_u...) says to remove the old modules:

"Please note that by restoring your 'sites' folder you will also be restoring the 'modules' folder(s) contained within it. Since this is coming from your backup, those modules folder(s) will contain modules for Drupal 5.x. Therefore, it is a good idea to empty out the modules folder(s) you have under the sites folder before moving onto the next steps. This will reduce the likelihood that you accidentally leave and old Drupal 5.x version of a module in place and forget to replace it with its Drupal 6.x version. Or worse, by leaving the folders in place, you may accidentally merge the contents of the Drupal 6.x version of a module folder with the old Drupal 5.x version."

If this is the case, what is the point of removing the modules and then putting them back only to remove them again later?

LeeHunter’s picture

And two more small things.

We should write "the new version of Drupal" or "the updated version of Drupal" wherever we current have "your version of Drupal". In this context, the word "your" is really ambiguous and distracting since we are actually wanting to draw attention to the need for compatibility with the new version ("your" could mean both the new and old versions).

It would also be good if there were a more meaningful heading. Right now there's nothing to indicate that this is the specific upgrade.txt file that goes with Drupal 6. During my own upgrade process I've had both the d5 and d6 installers floating around and at least once I've opened up the d5 version by mistake and didn't realize it until I started getting very confused. If there was a heading that said "Drupal 6 Upgrade Instructions" it might avoid that problem (at least when it comes to upgrading to d7).

LeeHunter’s picture

Priority: Normal » Critical

I'm bumping up the priority on this to critical, because the more I look at this, the more I realize that this file is dangerously misleading and incomplete. Following it faithfully can lead to all sorts of painful problems or outright failure.

The problem is that it very casually suggests backing up your old modules, copying in the upgrade files, putting back your modules and running update.php.

First of all, you can't just copy back your old module files. Most people will probably realize this but it still shouldn't be written this way.

Secondly, as I'm learning now as I flounder through my first major upgrade (thank God for test sites), you can't just toss in all of the upgraded modules all at once and run update.php. From everything I'm now reading this is dead wrong. According to this Best Practices page (http://drupal.org/node/29161), you should upgrade and activate modules one at time. In fact, the upgrade.txt file for CCK goes further to say specifically to leave all of the contrib modules OUT of the directory until the core modules are running and even then only copy the main CCK module over and do the upgrade for it before moving on to the other CCK modules. It goes on to say that modules get upgraded in the database when they're in the modules directory even if they are not enabled.

If this is correct, then I think this file should be fixed ASAP (as in the next point release if possible)

LeeHunter’s picture

Status: Active » Needs review
FileSize
6.58 KB

Ok, I've done a major rewrite of this file (see attached) which I think has addressed the above issues.

I am definitely NOT an expert on installing or upgrading Drupal, so it really needs careful review by people who actually know what they're doing. Some things I've added are definitely an improvement but other changes may be suspect.

In particular, I'm not at all sure that the way I've broken out steps for minor and major upgrades is correct.

LeeHunter’s picture

FileSize
6.71 KB

Missed a couple of steps.

LeeHunter’s picture

FileSize
10.97 KB

This is my first ever attempt at doing a real patch so I have no idea whether or not I've done it correctly. But here it is, for what it's worth.

JohnFilipstad’s picture

Project: Documentation » Drupal core
Version: » 6.x-dev
Component: Correction/Clarification » documentation

moving to Drupal project

flickerfly’s picture

Version: 6.x-dev » 7.x-dev

The wording this bug desires to replace is consistent in the 7.x version of the Drupal. The patch for D6 does not apply to D7 as some changes to that document have occurred in the D7 branch

I'm not sure about calling it Critical, but I'll leave that for someone else.

Here is the change log on that file since the patch was created. (This is from the git repo.)

$ git log UPGRADE.txtcommit 6aa5708a883f06c651d12d7c1b176b915f969088
Author: webchick <webchick>
Date:   Thu Nov 26 16:59:59 2009 +0000

    #637434 by casey, rickvug, and pbz1912: Remove mention of Bluemarine in UPGRADE

commit 10cc74d4db12978fa8ccb984aca6b87b0888bcb3
Author: webchick <webchick>
Date:   Fri Oct 9 07:48:06 2009 +0000

    #67234 by Ralf, Dave Reid, David_Rothstein, Rob Loach, dww, et al: Added a perm

commit 982ab6c7bafb158d3b8fb0f3a1cfcd5c3e4b99d9
Author: dries <dries>
Date:   Mon Sep 14 07:33:55 2009 +0000

    - Patch #570572 by winston, David_Rothstein | Shai, Xano, alexanderpas, emmajan

commit a3c40c83a89616d6ee7f19e87ed605d53f28d088
Author: webchick <webchick>
Date:   Tue Aug 11 17:26:33 2009 +0000

    #546048 by Gábor Hojtsy: Move maintenance mode setting to config/development.

commit 60fda392359e21e3a8e64a9ea325d86fcbf243a2
Author: dries <dries>
Date:   Sun Apr 19 19:10:07 2009 +0000

    - Patch #430342 by kkaefer et al: usability improvement: changed 'site maintena

commit 28f1928b7c24773e19235c5ebf50ff580d508932
Author: dries <dries>
Date:   Tue Jul 1 20:36:39 2008 +0000

    - Patch #277073 by threexk: improve consistency of offline vs off-line and onli

Status: Needs review » Needs work

The last submitted patch, UPGRADE.txt.patch, failed testing.

jerdiggity’s picture

+1 on the non-critical part (#8)
Adding to the list found here

jhodgdon’s picture

Priority: Critical » Normal
Issue tags: +Needs documentation

bump

yettyn’s picture

Status: Needs work » Closed (duplicate)

Making this a duplicate in favour of #295255: Clean-up the upgrade path: UPGRADE.txt, let's focus the energy to sort out this (important) document once and for all!