[G2] Redundant instructions in README.html

"Andy Staudacher" <[email protected]> Tue, 17 Oct 2006 12:08:26 +0200
Newsgroups gmane.comp.web.gallery.devel,gmane.comp.web.gallery.documentation
Message-ID <[email protected]>
I'm not happy with the sections "Preparing to install" and "Installing" in
our README.html.
We got a copy online in our codex:
http://codex.gallery2.org/index.php/Gallery2:How_do_I_Install_Gallery2#Prepa
ring_to_install
http://codex.gallery2.org/index.php/Gallery2:How_do_I_Install_Gallery2#Insta
lling_Gallery_2_2

Problems:
1. The "Preparing to install" section has no introduction, no leading
paragraph explaining what this section is about.
2. Point "1. Latest Version" in "Preparing to install" does not explain what
it's about. It should be "Get the latest version of Gallery", it's about
getting it.
3. "Preparing to install" is not clear about where you have to create the
storage folder, database, .. On the webserver maybe? 
4. Then in "Installing", we explain the same stuff again, in more detail.
But DB stuff is covered in a better way in the "Preparing" section.
- Uploading is covered, but "Pre-Installer" is above that bullet point,
doesn't make sense
- Uploading instructions are pretty redundant with "Latest version" from
"Preparing".
5. The storage setup is redundant between the two sections
6. We should use "password" as the example password for the MS SQL
instructions

The only reasons to keep a "Preparing" section that come to my mind are:
- We might want to keep the "Installing" process streamlined without
interruptions.
- Installing a DBMS, ensuring that there is an image toolkit... are actually
preparations.

But I'd like to move certain things into the "Installing" section:
- Move "Get the latest version" into the "Installing" section, and we can
remove redundancies between the two points
- Move the storage setup instructions into the "Installing" section

Do you prefer another restructuring? Got other ideas?

 - Andy


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
__[ g a l l e r y - d e v e l ]_________________________

[ list info/archive --> http://gallery.sf.net/lists.php ]
[ gallery info/FAQ/download --> http://gallery.sf.net ]