[documentation] RE: Suggest clarifications of update.txt for Drupal 5.0

[Karl Diederich]

On #7 below, an FYI:

  7. Run update.php by accessing http://<your_site_url>/update.php> with 
your browser. After the update has completed, you can close the browser.

<your_site_url>
  should be
    example.com

See: http://drupal.org/node/318, Drupal Coding Standards

Example URLs
Use "example.com" for all example URLs, per RFC 2606.

Thanks for the support and contribution


----Original Message Follows----
Message: 2
Date: Thu, 07 Sep 2006 21:52:50 +0000
From: bart <drupal-docs at drupal.org>
Subject: [documentation] [Documentation bug] Suggest clarifications of
	update.txt for Drupal 5.0
To: documentation at drupal.org
Message-ID: <type=project&nid=82488&cid=133984&host=@drupal.org>
Content-Type: text/plain; charset=UTF-8; format=flowed

Issue status update for
http://drupal.org/node/82488
Post a follow up:
http://drupal.org/project/comments/add/82488

  Project:      Documentation
  Version:      <none>
  Component:    Installation
  Category:     bug reports
  Priority:     normal
  Assigned to:  Anonymous
  Reported by:  bart at drupal.energybulletin.org
  Updated by:   bart at drupal.energybulletin.org
  Status:       active

Revised version (taking into account the comments in this thread):


BEGIN


Below is an outline of the steps to upgrade Drupal to a new version.
We strongly recommend that you read the complete information about
upgrading Drupal available at drupal.org.  For example:
http://drupal.org/upgrade/tutorial-introduction
http://drupal.org/node/29161



* Disable contributed modules in your Drupal site and revert to a
default theme (bluemarine). Make a list of contributed modules and
themes.


* Back up your database and the directory containing the Drupal files.
Important information for the upgrade resides in the configuration
files(s), such as <drupal_directory>/sites/default/settings.php.
* Access your Drupal site, and log on as the user with user ID 1 (the
first user you added during the installation - the administrator). DO
NOT CLOSE THE BROWSER UNTIL THE UPGRADE IS COMPLETE.
* Remove all the old Drupal files that came with the original
installation. Do not remove added files, such as any user-uploaded
files.
* Put the new Drupal files into the directory structure where the old
files resided. A simple way to do this is to unpack the Drupal upgrade
package in the directory from which you run Drupal.
*  Edit the new configuration file(s), such as
/sites/default/settings.php, to make sure it has the latest and correct
information. For example, you will probably re-set the values for
$db_url and $base_url. Check the old configuration file in the backup
you made for the proper settings.
* Run update.php by accessing http://<your_site_url>/update.php> with
your browser.  After the update has completed, you can close the
browser.
* Download and add contributed modules and themes for your site, once
they have been upgraded for the new release of Drupal.
The upgrade information at drupal.org explains how to recover from
errors and how to practice the upgrade on a test site (recommended for
production sites).


END


------------------------------------------------------


The background information from Neil (drumm), Steven (sepeck) and Gary
is very good, but I think the right home for it is in the online
handbooks.  There the information can be updated easily.  Background
information and corner cases can be organized so that they don't cause
confusion.


The beauty of the humble update.txt file is that it

* is short enough so that a reader can understand the whole process
quickly
* serves as a reminder to experienced people
* points people online for the complete story
.If this file tries to cover too much, it becomes unwieldy and
confusing.


-Bart




bart at drupal.energybulletin.org