[documentation] URGENT: Please review upgrade tutorial instructions

Kobus Myburgh itbjdm at puknet.puk.ac.za
Thu Dec 1 12:36:02 UTC 2005


> I think there are too many steps in the long version, and not enough
> in the short one. That, and it's not clear that there are two

Very well put. I was looking for a way to put this. Thanks!

> For the abbreviated upgrade, step one really must be "make a backup of
> your database and your files directory (okay fine, just the database

Definately!

> Then provide a link to trouble shooting resources to remind them that
> this is the risky way.

Agreed.

> * The command line instructions shouldn't be children of the GUI
> instructions, They should be on the same level.

That was what I tried doing by changing the parent of one of the command line options. It should probably be done as follows:

- Upgrade
- - GUI
- - - Child 1
- - - Child 2
- - Command Line
- - - Child 1
- - - Child 2

Instead of the way it is now:

- Upgrade
- - GUI
- - - Command Line

The way it would've been if I continued simply to change parents would've been as follows:

- Upgrade
- - Command Line Child 1
- - Command Line Child 2
- - GUI Child 1
- - GUI Child 2

And this is also not desireable. I'd say choose the first one. Can someone do that? What do others think?

> * The link to "Do I need to upgrade the db?" should be before you tell
> them how to upgrade the db

Yip!

> * There are still lots of CivicSpace references in the command line
> instructions.

This will be fixed over time, I believe, when they are spotted.

Regards,

Kobus




More information about the documentation mailing list