[documentation] URGENT: Please review upgrade tutorial instructions

Kieran Lal kieran at civicspacelabs.org
Thu Dec 1 08:54:51 UTC 2005


Well you can approach this from two different angles.

1) Do the logical thing and the right thing.(10 steps, back up your  
database etc.)
2) Do the thing that human beings will actually do. (download newest  
code, hit update.php)

I fought for 1) for many months.  In the end I interviewed enough  
users and talked to enough site administrators to realize that  
everyone was going to do 2).  So I gave up and just gave them what  
they wanted.

We designed the tutorial in a way that it was going to provide the  
two basic steps for everyone, and the advanced steps for those who  
listen to their teachers, look both ways before crossing the street,  
and eat their broccoli.

Kieran


On Dec 1, 2005, at 12:38 AM, Kobus Myburgh wrote:

> Oh... one more thing:
>
> "
> There are two basic steps involved in upgrading your Drupal site:
>
> Download and unzip the new Drupal files to your server.
> Run the update.php script which will update your database.
> "
>
> This should be reworded to include the fact that you need to backup  
> as well. In my opinion, this is the MOST CRITICAL part of the update.
>
> Regards,
>
> Kobus
>
>
>
>>>> kieran at civicspacelabs.org 12/1/2005 10:16:36 AM >>>
>
> On Nov 30, 2005, at 11:59 PM, Kobus Myburgh wrote:
>
>
>> I have changed the parent of this: http://drupal.org/upgrade/
>> copying-your-live-site-via-command-line
>>
>> to NOT be the corresponding version for the GUI method, but the
>> same as the GUI method's parent.
>
> I don't follow.
>
>> If this is approved, we can change them all and get rid of the
>> duplicate links on the upgrade overview page.
>
> Which duplicate links?  You mean duplicate because this is a book,
> and we have child pages that are the same?  I would rather do this as
> pages because I don't think book navigation is that good for jumping
> around in a tutorial like this.  If I get page permission I redo them
> as pages not book pages.  What do others think?  Look how it is done
> at http://civicspacelabs.org/upgrade
>>
>> I have also removed the font inconsistencies on this page: http://
>> drupal.org/upgrade/tutorial-introduction. I didn't color the link
>> to something else, because I felt that the section stating "Jump
>> to..." highlights the means for a different colour enough.
>
> The font needs to be returned to be larger for the Basic Upgrade
> steps.  Most users won't read more than the basic steps and the large
> font brings this to their attention.  If not a larger font, then a
> color.  Users expect upgrading to be a two step process.  So we must
> bring the basic steps to their attention.  If they see upgrading as a
> 10 step process they will conclude they can not upgrade.
>>
>> I am going to stop changes now until I get some feedback, because
>> all of the other changes are ones that I can fix (images missing)
>> or typos or repeats of previous fixes.
>>
>> Regards,
>>
>> Kobus
>>
>>
>>>>> itbjdm at puknet.puk.ac.za 12/1/2005 9:47:21 AM >>>
>> I doubt that I have write access there. I haven't explicitly asked
>> for write access, so I doubt I would have.
>>
>> I have fixed the first page (note particularly the yellow block -
>> if this is okay. I will fix the rest as well).
>>
>> http://drupal.org/upgrade/basic-steps-via-GUI
>>
>> Regards,
>>
>> Kobus
>>
>>
>>>>> kieran at civicspacelabs.org 12/1/2005 9:35:14 AM >>>
>> Do you have write access to Drupal.org?
>>
>> If you can upload them, go for it.
>>
>> Kieran
>> On Nov 30, 2005, at 11:30 PM, Kobus Myburgh wrote:
>>
>>> Wouldn't it be better to have those images located on Drupal org?
>>>
>>> Regards,
>>>
>>> Kobus
>>>
>>>
>>>>>> kieran at civicspacelabs.org 12/1/2005 9:26:24 AM >>>
>>>
>>> On Nov 30, 2005, at 11:18 PM, Kobus Myburgh wrote:
>>>
>>>> I can make some of the changes if you wish? If you can tell me what
>>>> the exact URL of the images SHOULD be, I can also fix the images
>>>> problems?
>>>
>>> http://civicspacelabs.org/home/upgrade/basic
>>>
>>> The image links are there from the original.  But they might be
>>> slightly corrupted on that site.
>>>
>>> Kieran
>>>>
>>>> Regards,
>>>>
>>>> Kobus
>>>>
>>>>
>>>>>>> kieran at civicspacelabs.org 12/1/2005 9:12:20 AM >>>
>>>> Thanks for the feedback.  If anyone can make this changes I'd
>>>> like to
>>>> review them.
>>>>
>>>> Kieran
>>>> On Nov 30, 2005, at 10:50 PM, Kobus Myburgh wrote:
>>>>
>>>>> Kieran,
>>>>>
>>>>> First of all: Great work!
>>>>>
>>>>> * I have the same font inconsistencies issues than the others and
>>>>> all pages with images in them have at least one missing.
>>>>>
>>>>> * Also, why are so many of the links duplicated? [1] This is a bit
>>>>> strange to me.
>>>>>
>>>>> * In the yellow block in the basic steps via GUI [2], you have
>>>>> this: "*** If you are upgrading from a version of Drupal that is
>>>>> older than Drupal 4.5 or older, then...". That sentence is
>>>>> incorrect. How about simply: "*** If you are upgrading from a
>>>>> version older than Drupal 4.5, then..."
>>>>>
>>>>> * This exact same yellow block also needs some spacing to make it
>>>>> more readible. This is also holds for other places with this  
>>>>> yellow
>>>>> box [3][5].
>>>>>
>>>>> * 3. If you are performing any of these upgrade. You do not  
>>>>> need to
>>>>> upgrade your database: 4.5.0 to 4.5.# (Believe that should be
>>>>> 4.5.x? Or 4.5.3? [4] This possible problem occurs on several  
>>>>> places
>>>>> on this page.
>>>>>
>>>>> * I suggest that all blockquoted text (code or blockquote,  
>>>>> anyways)
>>>>> be made the same as here [6]. It stands out nicely with the bold
>>>>> inside the block.
>>>>>
>>>>> * Inconsistencies in bold text, as described above here too: [7].
>>>>>
>>>>> * [7][8][9][10]: These pages have some comments that can be
>>>>> removed, I believe. Also a lot of the pages after that, but I see
>>>>> this will be a lot of pages, so I won't list them all here.
>>>>>
>>>>> * [8][9]: Are these pages still necessary? Can't they be  
>>>>> deleted? A
>>>>> lot of other pages too - are they still relevant? Not a technical
>>>>> guru, so I won't know, but this page [11] might not be relevant in
>>>>> its entirety anymore.
>>>>>
>>>>> Regards,
>>>>>
>>>>> Kobus
>>>>>
>>>>> [1]
>>>>> Copying your live site to a test site | (Command-Line Version)
>>>>> Basic Upgrade Steps | (Command-Line Version) | (No Database  
>>>>> update)
>>>>> Optional Configuration Steps
>>>>> Testing your newly upgraded site
>>>>> Upgrade Finished!
>>>>> Copy your test site to your live site | (Command-Line Version)
>>>>>
>>>>> Continue to Copying Your Live Site to a Test Site
>>>>> Jump to Basic Upgrade Steps
>>>>>
>>>>> Copy your live site to a test site(GUI version)
>>>>> Basic Upgrade Steps (GUI version)
>>>>> Optional Configuration Steps
>>>>> Testing Your Newly Upgraded Site
>>>>> Upgrade Finished!
>>>>> Copy your test site to a live site (GUI Version)
>>>>>
>>>>> [2] http://drupal.org/upgrade/basic-steps-via-GUI
>>>>> [3] http://drupal.org/upgrade/basic-steps-via-command-line
>>>>> [4] http://drupal.org/upgrade/upgrading-the-database
>>>>> [5] http://drupal.org/upgrade/upgrading-without-a-db-upgrade
>>>>> [6] http://drupal.org/upgrade/testing-the-new-site
>>>>> [7] http://drupal.org/node/30699
>>>>> [8] http://drupal.org/node/505
>>>>> [9] http://drupal.org/node/269
>>>>> [10] http://drupal.org/node/271
>>>>> [11] http://drupal.org/node/2602
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>>>>
>>>>
>>>> -- 
>>>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>>>
>>>> --
>>>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>>>
>>>
>>> -- 
>>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>>
>>> --
>>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>>
>>
>> -- 
>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>> --
>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>> --
>> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>>
>
> -- 
> [ documentation | http://lists.drupal.org/listinfo/documentation ]
> --
> [ documentation | http://lists.drupal.org/listinfo/documentation ]
>



More information about the documentation mailing list