From bcee886c97823722c7f56694dc642c6188775ad4 Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Fri, 4 Apr 2008 11:46:47 +0000 Subject: Another pre-2.17.7 rev. --- docs/en/xml/Bugzilla-Guide.xml | 4 +- docs/en/xml/about.xml | 16 +-- docs/en/xml/conventions.xml | 22 ++-- docs/en/xml/installation.xml | 286 +++++++++++++++++++---------------------- docs/en/xml/introduction.xml | 38 +++--- docs/en/xml/using.xml | 73 ++++++----- 6 files changed, 209 insertions(+), 230 deletions(-) (limited to 'docs') diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml index 8fb74a31a..1ed018678 100644 --- a/docs/en/xml/Bugzilla-Guide.xml +++ b/docs/en/xml/Bugzilla-Guide.xml @@ -40,11 +40,11 @@ Bugzilla Documentation"> - + - + diff --git a/docs/en/xml/about.xml b/docs/en/xml/about.xml index 28cc9d8c7..1d48fde19 100644 --- a/docs/en/xml/about.xml +++ b/docs/en/xml/about.xml @@ -67,16 +67,14 @@ ]]> - The newest version of this guide can always be found at ; however, you should read the version + The latest version of this guide can always be found at , or checked out via CVS. + (Please follow the Mozilla + CVS instructions and check out the + mozilla/webtools/bugzilla/docs/ + subtree.) However, you should read the version which came with the Bugzilla release you are using. - - The latest version of this document can always be checked out via CVS. - Please follow the Mozilla CVS - instructions and check out the mozilla/webtools/bugzilla/docs/ - subtree. - The Bugzilla Guide is currently only available in English. If you would like to volunteer to translate it, please contact @@ -116,7 +114,7 @@ Last but not least, all the members of the - + netscape.public.mozilla.webtools newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened. diff --git a/docs/en/xml/conventions.xml b/docs/en/xml/conventions.xml index 5f3bcb35d..24986d66b 100644 --- a/docs/en/xml/conventions.xml +++ b/docs/en/xml/conventions.xml @@ -20,7 +20,7 @@ - Warnings + Warning @@ -40,7 +40,7 @@ - Notes + Note @@ -60,7 +60,7 @@ - File and directory names + File or directory name filename @@ -68,7 +68,7 @@ - Commands to be typed + Command to be typed command @@ -76,7 +76,7 @@ - Applications names + Application name application @@ -85,27 +85,21 @@ - Prompt - - of users command under bash shell + Normal user's prompt under bash shell bash$ - Prompt - - of root users command under bash shell + Root user's prompt under bash shell bash# - Prompt - - of user command under tcsh shell + Normal user's prompt under tcsh shell tcsh$ diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml index a435b7f19..bcc522c98 100644 --- a/docs/en/xml/installation.xml +++ b/docs/en/xml/installation.xml @@ -1,5 +1,5 @@ - + Installation @@ -11,7 +11,8 @@ Microsoft Windows. Many operating systems have utilities that make installation easier or quirks that make it harder. We have tried to collect that information in - , so be sure to check out that section before + , so unless you are on Linux, + be sure to check out that section before you start your installation. @@ -25,7 +26,8 @@ While installing Bugzilla, it is a good idea to ensure that there - is some kind of firewall between you and the rest of the Internet + is some kind of configurable firewall between you and the rest of the + Internet as your machine may be insecure for periods during the install. Many installation steps require an active Internet connection to complete, but you must take care to ensure that at no point is your machine @@ -34,31 +36,30 @@ This guide assumes that you already have your operating system installed, network configured, and have administrative access to the - shell on the machine you are installing Bugzilla onto. It is possible to - install and run Bugzilla without administrative access, but you have to + machine onto which you are installing Bugzilla. It is possible to + install and run Bugzilla itself without administrative access, but you + have to either make sure all the required software is installed or get somebody with administrative access to install it for you. You are strongly recommended to make a backup of your system - before installing Bugzilla and at regular intervals thereafter. + before installing Bugzilla (and at regular intervals thereafter :-). - The listing below is a basic step-by-step list. More information - can be found in the sections below. Minimum versions will be - included in parenthesis where appropriate. + Here's a basic step-by-step list: Install Perl - (&min-perl-ver;) + (&min-perl-ver; or above) Install MySQL - (&min-mysql-ver;) + (&min-mysql-ver; or above) @@ -83,7 +84,8 @@ Perl Any machine that doesn't have Perl on it is a sad machine indeed. - Perl can be got in source form from . + If your OS doesn't come with it, Perl can be got in source form + from . There are also binary versions available for many platforms, most of which are linked to from perl.com. Although Bugzilla runs with perl &min-perl-ver;, @@ -95,7 +97,8 @@
MySQL - Visit the MySQL homepage at + If your OS doesn't come with it or provide official packages, + visit the MySQL homepage at to grab and install the latest stable release of the server. @@ -136,16 +139,17 @@ set-variable = max_allowed_packet=1M If you are running Bugzilla and MySQL on the same machine, you may - also wish to utilize the option as + also wish to utilize the option as mentioned in for the added security.
- Configuring MySQL + Adding a user to MySQL This first thing you'll want to do is make sure you've given the root user a password as suggested in - . For clarity, these instructions will + . Then, you need to add a user for + Bugzilla to use. For clarity, these instructions will assume that your MySQL user for Bugzilla will be bugs_user, the database will be called bugs_db and the password for the bugs_user user is bugs_password. You @@ -154,14 +158,13 @@ set-variable = max_allowed_packet=1M Most people use bugs for both the user and - database name. + database name. Don't use it for the password, though... - Next, we use an SQL GRANT command to create a + We use an SQL GRANT command to create a bugs_user - user, and grant sufficient permissions for checksetup.pl, which we'll - use later, to work its magic. This also restricts the + user. This also restricts the bugs_user user to operations within a database called bugs_db, and only allows the account to connect from @@ -179,7 +182,9 @@ set-variable = max_allowed_packet=1M If you are using MySQL 4, the bugs user also needs to be granted the LOCK TABLES and - CREATE TEMPORARY TABLES permissions. + CREATE TEMPORARY TABLES permissions, + so add them to the list in the + GRANT command.
@@ -217,21 +222,16 @@ set-variable = max_allowed_packet=1M directory. - If you symlink the bugzilla directory into your Apache's HTML + If you symlink the bugzilla directory into your Apache's + html hierarchy, you may receive Forbidden errors unless you add the - FollowSymLinks - directive to the <Directory> entry for the HTML root - in httpd.conf. + FollowSymLinks + directive to the <Directory> entry for + the HTML root directory in httpd.conf. - Once all the files are in a web accessible directory, make that - directory writable by your webserver's user. This is a temporary step - until you run the post-install - checksetup.pl - script, which locks down your installation. - The default Bugzilla distribution is not designed to be placed in a cgi-bin directory (this @@ -239,15 +239,104 @@ set-variable = max_allowed_packet=1M directive of Apache). + + Once all the files are in a web accessible directory, make that + directory writable by your webserver's user. This is a temporary step + until you run the post-install + checksetup.pl + script, which locks down your installation. + +
+ +
+ + <filename>checksetup.pl</filename> + + + Next, run the magic checksetup.pl script. + This is designed to check whether you have all of the right + Perl modules in the correct + versions, and that Bugzilla is generally set up correctly. + + + + Eventually, + it will make sure Bugzilla files and directories have reasonable + permissions, set up the + data + directory, and create all the MySQL tables. But the first time you + run it, it's highly likely to tell you that you are missing a few + Perl modules. Make a note of which ones they are, and then proceed to + the next section to install them. + + + +bash# ./checksetup.pl + + + + The first time you run it with all the correct modules installed, + it will create a file called + localconfig. + + This file contains a variety of settings you may need to tweak + including how Bugzilla should connect to the MySQL database. + + The connection settings include: + + + server's host: just use + localhost + if the MySQL server is local + + + + database name: + bugs_db + if you're following these directions + + + + MySQL username: + bugs_user + if you're following these directions + + + + Password for the + bugs_user + MySQL account; (bugs_password above) + + + + + Edit the file to change these. Once you are happy with the + settings, su to the user + your web server runs as, and re-run + checksetup.pl. (Note: on some security-conscious + systems, you may need to change the login shell for the webserver + account before you can do this.) + On this second run, it will create the database and an administrator + account for which you will be prompted to provide information. + + + The checksetup.pl script is designed so that you can run it at + any time without causing harm. You should run it after any upgrade to + Bugzilla. +
Perl Modules + Don't be intimidated by this long list of modules. See + for a way of + installing all the ones you need with a single command. + + Perl modules can be found using CPAN on Unix based systems or - PPM on Win32. The root servers - have a real tendency to bog down, so please use mirrors. + PPM on Win32. Good instuctions can be found for using each of these services on @@ -310,7 +399,6 @@ set-variable = max_allowed_packet=1M Perl Modules (minimum version): - Bundle::Bugzilla @@ -318,13 +406,6 @@ set-variable = max_allowed_packet=1M - - - AppConfig - (&min-appconfig-ver;) - - - CGI @@ -332,13 +413,6 @@ set-variable = max_allowed_packet=1M - - - Data::Dumper - (&min-data-dumper-ver;) - - - Date::Format @@ -477,14 +551,6 @@ ReadLine support enabled
-
- AppConfig (&min-appconfig-ver;) - - Dependency for Template Toolkit. We probably don't need to - specifically check for it anymore. - -
-
CGI (&min-cgi-ver;) @@ -500,22 +566,6 @@ ReadLine support enabled
-
- Data::Dumper (&min-data-dumper-ver;) - - The Data::Dumper module provides data structure persistence for - Perl (similar to Java's serialization). It comes with later - sub-releases of Perl 5.004, but a re-installation just to be sure it's - available won't hurt anything. - - - - CPAN Download Page: - PPM Download Link: - Documentation: - -
-
TimeDate modules (&min-date-format-ver;) @@ -637,12 +687,8 @@ ReadLine support enabled
GD (&min-gd-ver;) [optional] - The GD library was written by Thomas Boutell a long while ago to - programmatically generate images in C. Since then it's become the - defacto standard for programmatic image construction. The Perl bindings - to it found in the GD library are used on millions of web pages to - generate graphs on the fly. That's what Bugzilla will be using it for - so you must install it if you want any of the graphing to work. + You need the GD library if you want any of the graphing to work. + The Perl GD library requires some other libraries that may or @@ -687,7 +733,7 @@ ReadLine support enabled
- XML::Parser (&min-xml-parser-ver;) [Optional] + XML::Parser (&min-xml-parser-ver;) [optional] XML::Parser is used by the importxml.pl script. You only need it if you are going to be importing bugs (such as @@ -704,7 +750,7 @@ ReadLine support enabled
- GD::Graph (&min-gd-graph-ver;) [Optional] + GD::Graph (&min-gd-graph-ver;) [optional] In addition to GD listed above, the reporting interface of Bugzilla needs to have the GD::Graph module installed. @@ -718,7 +764,7 @@ ReadLine support enabled
- GD::Text::Align (&min-gd-text-align-ver;) [Optional] + GD::Text::Align (&min-gd-text-align-ver;) [optional] GD::Text::Align, as the name implies, is used to draw aligned strings of text. It is needed by the reporting interface. @@ -732,7 +778,7 @@ ReadLine support enabled
- MIME::Parser (&min-mime-parser-ver;) [Optional] + MIME::Parser (&min-mime-parser-ver;) [optional] MIME::Parser is only needed if you want to use the e-mail interface located in the contrib directory. @@ -746,7 +792,7 @@ ReadLine support enabled
- PatchReader (&min-patchreader-ver;) [Optional] + PatchReader (&min-patchreader-ver;) [optional] PatchReader is only needed if you want to use Patch Viewer, a Bugzilla feature to format patches in a pretty HTML fashion. There are a @@ -767,77 +813,13 @@ ReadLine support enabled
- - <filename>checksetup.pl</filename> - - - Next, run the magic checksetup.pl script. - This is designed to make sure your perl modules are the correct - version and your MySQL database and other - configuration options are consistent with the Bugzilla CGI files. - It will make sure Bugzilla files and directories have reasonable - permissions, set up the - data - directory, and create all the MySQL tables. - - - -bash# ./checksetup.pl - - + Configuring Bugzilla - The first time you run it, it will create a file called - localconfig. - - This file contains a variety of settings you may need to tweak - including how Bugzilla should connect to the MySQL database. - - The connection settings include: - - - server's host: just use - localhost - if the MySQL server is local - - - - database name: - bugs_db - if you're following these directions - - - - MySQL username: - bugs_user - if you're following these directions - - - - Password for the - bugs_user - MySQL account; (bugs_password above) - - + Once checksetup.pl has run successfully, Bugzilla should start up. + Proceed to the correct URL and log in with the administrator account + you defined in the last checksetup.pl run. - - Once you are happy with the settings, - su to the user - your web server runs as, and re-run - checksetup.pl. (Note: on some security-conscious - systems, you may need to change the login shell for the webserver - account before you can do this.) - On this second run, it will create the database and an administrator - account for which you will be prompted to provide information. - - - The checksetup.pl script is designed so that you can run it at - any time without causing harm. You should run it after any upgrade to - Bugzilla. - -
- -
- Configuring Bugzilla + You should run through the parameters on the Edit Parameters page (link in the footer) and set them all to appropriate values. diff --git a/docs/en/xml/introduction.xml b/docs/en/xml/introduction.xml index d01e39979..5cf4a5599 100644 --- a/docs/en/xml/introduction.xml +++ b/docs/en/xml/introduction.xml @@ -17,30 +17,23 @@
Why use a bug-tracking system? - For many years, defect-tracking software was principally - the domain of large software development houses. Most smaller shops - simply relied on - shared lists and email to monitor the status of defects. This procedure - was error-prone and tended to cause those bugs judged least significant by - developers to be dropped or ignored. - - Integrated - defect-tracking systems reduce downtime, increase productivity, and raise - customer satisfaction with their systems. Along with full disclosure, an - open bug-tracker allows you to keep in touch with your clients - and resellers, to communicate about problems effectively throughout the - data management chain. Many corporations have also discovered that - defect-tracking helps reduce costs by providing IT support - accountability, telephone support knowledge bases, and a common, - well-understood method for accounting for unusual system or software - issues. + Those who do not use a bug-tracking system tend to rely on + shared lists, email, spreadsheets and/or Post-It notes to monitor the + status of defects. This procedure + is usually error-prone and tends to cause those bugs judged least + significant by developers to be dropped or ignored. + + Integrated defect-tracking systems make sure that nothing gets + swept under the carpet; they provide a method of creating, storing, + arranging and processing defect reports and enhancement requests.
Why use Bugzilla? - Bugzilla boasts many advanced features. These include: + Bugzilla is the leading open-source/free software bug tracking + system. It boasts many advanced features, including: Powerful searching @@ -75,12 +68,12 @@ - Web, XML, email and console interfaces + Completely customisable and/or localisable web user + interface - Completely customisable and/or localisable web user - interface + Additional XML, email and console interfaces @@ -102,8 +95,7 @@ CVS, Bonsai, or Perforce SCM, Bugzilla - provides a powerful, easy-to-use solution to configuration management and - replication problems. + provides a powerful, easy-to-use configuration management solution.
diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml index 21614e740..27f745df5 100644 --- a/docs/en/xml/using.xml +++ b/docs/en/xml/using.xml @@ -3,14 +3,17 @@ Using Bugzilla - This section contains information for end-users of Bugzilla. - There is a Bugzilla test installation, called - Landfill, - which you are welcome to play with (if it's up.) - However, it does not necessarily - have all Bugzilla features enabled, and runs an up-to-the-minute version, - so some things may not quite work as this document describes. - +
+ Introduction + This section contains information for end-users of Bugzilla. + There is a Bugzilla test installation, called + Landfill, + which you are welcome to play with (if it's up.) + However, it does not necessarily + have all Bugzilla features enabled, and runs an up-to-the-minute version, + so some things may not quite work as this document describes. +
+
Create a Bugzilla Account @@ -295,6 +298,12 @@ this gives you a large page with a non-editable summary of the fields of each bug. + + CSV: + + get the buglist as comma-separated values, for import into e.g. + a spreadsheet. + Change Columns: @@ -313,11 +322,18 @@ Sends mail to the owners of all bugs on the list. - Edit this query: + Edit Search: If you didn't get exactly the results you were looking for, you can return to the Query page through this link and make small revisions to the query you just made so you get more accurate results. + + + Remember Search As: + + You can give a search a name and remember it; a link will appear + in your page footer giving you quick access to run it again later. +
@@ -365,6 +381,24 @@ Select "Commit" and send in your bug report. + + Try to make sure that everything said in the summary is also + said in the first comment. Summaries are often updated and this will + ensure your original information is easily accessible. + + + + You do not need to put "any" or similar strings in the URL field. + If there is no specific URL associated with the bug, leave this + field blank. + + + If you feel a bug you filed was incorrectly marked as a + DUPLICATE of another, please question it in your bug, not + the bug it was duped to. Feel free to CC the person who duped it + if they are not already CCed. + +
@@ -552,27 +586,6 @@ out of the bug.
- -
- Filing Bugs - - Try to make sure that everything said in the summary is also - said in the first comment. Summaries are often updated and this will - ensure your original information is easily accessible. - - - - You do not need to put "any" or similar strings in the URL field. - If there is no specific URL associated with the bug, leave this - field blank. - - - If you feel a bug you filed was incorrectly marked as a - DUPLICATE of another, please question it in your bug, not - the bug it was duped to. Feel free to CC the person who duped it - if they are not already CCed. - -
-- cgit v1.2.3-24-g4f1b