503543 - Merge README, QUICKSTART, UPGRADING

Status: RESOLVED FIXED

(Bugzilla :: Documentation, enhancement, P1)

Description

[Frédéric Buclin]

I don't think a newbie needs 3 files to start installing Bugzilla. We should have a single README or INSTALL file, and that's all. This would also be a good opportunity to refresh the information in them, which is pretty obsolete.

Comment 1

[Max Kanat-Alexander]

Yeah, agreed. All that info should go into the README (or we should just direct the user to the docs, for some of it).

Comment 2

[Frédéric Buclin]

Attachment: patch, v1

The QUICKSTART file written by kiko is really good, and can be a good starting point for the impatients. So I merged it with README and updated obsolete statements. I also added the first two new sections, which are new.

Comment 3

[Max Kanat-Alexander]

Comment on attachment 391241 [details] [diff] [review]
patch, v1

  The "documentation to install, configure..." part should probably be its own section, not a part of "Minimum Requirements".

>+Bugzilla is a *free* bug-tracking system hosted by Mozilla and developed by
>+an active community. You can install and use it without having to pay
>+any license fee.

  "hosted by Mozilla" is confusing, I think, because it sounds like there's only one Bugzilla. Let's say:

  "Bugzilla is a free bug-tracking system that is developed by an active community of volunteers in the Mozilla community."

  (We can remove asterisks around "free", I think.)

>+It can be installed on Windows, MacOSX, Linux and other Unix flavors.

  Mac OS X

>+5. Using the name you provided as $db_name above, create a MySQL database
>+   for Bugzilla. You should also create a user permission for the name
>+   supplied as $db_user with read/write access to that database.

  Actually, you don't need to create a database, just a user. It's better if you don't create the database.


>+7. Configure Apache (or install and configure, if you don't have it up
>+   yet) to point to the Bugzilla directory.

  It would be better to point to the docs for the specifics of this part, I think, because that allows people to choose between mod_perl (which is recommended) and mod_cgi (which is only for people who can't use mod_perl). Also, we update the docs/ config more often than we'll update this README.

Comment 4

[Frédéric Buclin]

Attachment: patch, v2

This fixes everything reported by mkanat.

Comment 5

[Max Kanat-Alexander]

Comment on attachment 391252 [details] [diff] [review]
patch, v2

>+Installation
>+============

  Let's make it "Installation & Upgrading"

>+7. Configure Apache (or install and configure, if you don't have it up
>+   yet) to point to the Bugzilla directory. You can choose between
>+   mod_cgi and mod_perl. The documentation has detailed information
>+   for both modes.

  Let's say "The Bugzilla documentation". (Otherwise people might go looking for the Apache documentation.)


  Otherwise looks good! That can all be fixed on checkin.

Comment 6

[Max Kanat-Alexander]

Let's limit this to 3.2, because of docs/en/.

Comment 7

[Frédéric Buclin]

Attachment: patch, v3

Fixes mkanat's comments + remove the very obsolete UPGRADING-pre-2.8 file (most instructions to ugprade Bugzilla won't work because they refer to methods and/or DB columns which no longer exists since 2.20 or 2.22).

Comment 8

[Frédéric Buclin]

tip:

Removing QUICKSTART;
/cvsroot/mozilla/webtools/bugzilla/QUICKSTART,v  <--  QUICKSTART
new revision: delete; previous revision: 1.8
done
Checking in README;
/cvsroot/mozilla/webtools/bugzilla/README,v  <--  README
new revision: 1.53; previous revision: 1.52
done
Removing UPGRADING;
/cvsroot/mozilla/webtools/bugzilla/UPGRADING,v  <--  UPGRADING
new revision: delete; previous revision: 1.1
done
Removing UPGRADING-pre-2.8;
/cvsroot/mozilla/webtools/bugzilla/UPGRADING-pre-2.8,v  <--  UPGRADING-pre-2.8
new revision: delete; previous revision: 1.4
done


3.4:

Removing QUICKSTART;
/cvsroot/mozilla/webtools/bugzilla/Attic/QUICKSTART,v  <--  QUICKSTART
new revision: delete; previous revision: 1.8
done
Checking in README;
/cvsroot/mozilla/webtools/bugzilla/README,v  <--  README
new revision: 1.52.18.1; previous revision: 1.52
done
Removing UPGRADING;
/cvsroot/mozilla/webtools/bugzilla/Attic/UPGRADING,v  <--  UPGRADING
new revision: delete; previous revision: 1.1
done
Removing UPGRADING-pre-2.8;
/cvsroot/mozilla/webtools/bugzilla/Attic/UPGRADING-pre-2.8,v  <--  UPGRADING-pre-2.8
new revision: delete; previous revision: 1.4
done


3.2.4:

Removing QUICKSTART;
/cvsroot/mozilla/webtools/bugzilla/Attic/QUICKSTART,v  <--  QUICKSTART
new revision: delete; previous revision: 1.8
done
Checking in README;
/cvsroot/mozilla/webtools/bugzilla/README,v  <--  README
new revision: 1.52.16.1; previous revision: 1.52
done
Removing UPGRADING;
/cvsroot/mozilla/webtools/bugzilla/Attic/UPGRADING,v  <--  UPGRADING
new revision: delete; previous revision: 1.1
done
Removing UPGRADING-pre-2.8;
/cvsroot/mozilla/webtools/bugzilla/Attic/UPGRADING-pre-2.8,v  <--  UPGRADING-pre-2.8
new revision: delete; previous revision: 1.4
done