General updates. I'm working through the entire guide, tidying it up.

This commit is contained in:
gerv%gerv.net 2002-05-01 23:48:33 +00:00
parent f4ef397c40
commit 8d6d106b0d
6 changed files with 54 additions and 226 deletions

View File

@ -20,13 +20,13 @@
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bz-ver "2.14">
<!ENTITY bz-cvs-ver "2.15">
<!ENTITY bzg-date "August 10, 2001">
<!ENTITY bzg-ver "2.14">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
<!ENTITY bz-ver "2.16">
<!ENTITY bz-cvs-ver "2.17">
<!ENTITY bzg-date "April 2nd, 2002">
<!ENTITY bzg-ver "2.16">
<!ENTITY bzg-cvs-ver "2.17.0">
<!ENTITY bzg-auth "The Bugzilla Team">
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">

View File

@ -6,13 +6,6 @@
<section id="aboutthisguide">
<title>Purpose and Scope of this Guide</title>
<para>
This document was started on September 17, 2000 by Matthew P.
Barnson after a great deal of procrastination updating the
Bugzilla FAQ, which I left untouched for nearly half a year.
After numerous complete rewrites and reformatting, it is the
document you see today.
</para>
<para>
Bugzilla is simply the best piece of bug-tracking software the
world has ever seen. This document is intended to be the
@ -43,20 +36,12 @@
digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
Got it? Good.
</para>
<para>
I wrote this in response to the enormous demand for decent
Bugzilla documentation. I have incorporated instructions from
the Bugzilla README, Frequently Asked Questions, Database Schema
Document, and various mailing lists to create it. Chances are,
there are glaring errors in this documentation; please contact
&bzg-auth-email; to correct them.
</para>
</section>
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
<attribution>Copyright (c) 2000-2001 &bzg-auth;</attribution>
<attribution>Copyright (c) 2000-2002 Matthew P. Barnson and &bzg-auth;</attribution>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
@ -64,7 +49,7 @@
Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license is included in the section entitled "GNU Free
Documentation LIcense".
Documentation License".
</para>
</blockquote>
<para>
@ -94,7 +79,7 @@
</para>
<para>
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". I
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux in every situation
where it is appropriate. It is an extremely versatile, stable,
and robust operating system that offers an ideal operating
@ -103,8 +88,7 @@
<para>
You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter.
Heaven knows it's saved my bacon time after time; if you
implement any suggestion in this Guide, implement this one!
If you implement any suggestion in this Guide, implement this one!
</para>
<para>
Although the Bugzilla development team has taken great care to
@ -138,12 +122,7 @@
<itemizedlist>
<listitem>
<para>
<ulink url="http://www.trilobyte.net/barnsons/">TriloBYTE</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ulink>
<ulink url="http://www.bugzilla.org/">bugzilla.org</ulink>
</para>
</listitem>
<listitem>
@ -157,7 +136,7 @@
<para>
The latest version of this document can be checked out via CVS.
Please follow the instructions available at <ulink
url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the mozilla/webtools/bugzilla/docs/ branch.
url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
</para>
</section>
@ -169,6 +148,10 @@
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<para>
<ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink>
for pulling together the Bugzilla Guide and shepherding it to 2.14.
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
for initially writing Bugzilla and creating the
@ -194,27 +177,13 @@
Last but not least, all the members of the <ulink
url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
</para>
</section>
<section id="contributors">
<title>Contributors</title>
<para>
Thanks go to these people for significant contributions to this
documentation (in no particular order):
Thanks also go to the following people for significant contributions
to this documentation (in no particular order):
</para>
<para>
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</para>
</section>
<section id="feedback">
<title>Feedback</title>
<para>
I welcome feedback on this document. Without your submissions
and input, this Guide cannot continue to exist. Please mail
additions, comments, criticisms, etc. to
<email>barnboy@trilobyte.net</email>. Please send flames to
<email>devnull@localhost</email>
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
</para>
</section>
@ -226,7 +195,7 @@
translate this Guide, please notify the members of the
mozilla-webtools mailing list at
<email>mozilla-webtools@mozilla.org</email>, and arrange with
Matt Barnson to check it into CVS.
&bzg-auth; to check it into CVS.
</para>
</section>

View File

@ -43,7 +43,7 @@ Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
Tracking Systems allow individual or groups of developers to keep
track of outstanding bugs in their product effectively. Bugzilla was
originally written by Terry Weissman in a programming language called
"TCL", to replace a crappy bug-tracking database used internally for
"TCL", to replace a crappy bug-tracking database used internally by
Netscape Communications. Terry later ported Bugzilla to Perl from
TCL, and in Perl it remains to this day. Most commercial
defect-tracking software vendors at the time charged enormous
@ -87,7 +87,7 @@ system against which all others are measured.
</listitem>
<listitem>
<para>
email, XML, console, and HTTP APIs
email, XML, console, and web interfaces
</para>
</listitem>
<listitem>
@ -105,30 +105,6 @@ system against which all others are measured.
</listitem>
</itemizedlist>
</para>
<para>
Despite its current robustness and popularity, Bugzilla faces
some near-term challenges, such as reliance on a single
database, a lack of abstraction of the user interface and
program logic, verbose email bug notifications, a powerful but
daunting query interface, little reporting configurability,
problems with extremely large queries, some unsupportable bug
resolution options, little internationalization (although non-US
character sets are accepted for comments), and dependence on
some nonstandard libraries.
</para>
<para>
Some recent headway has been made on the query front, however.
If you are using the latest version of Bugzilla, you should see
a <quote>simple search</quote> form on the default front page of
your Bugzilla install. Type in two or three search terms and
you should pull up some relevant information. This is also
available as "queryhelp.cgi".
</para>
<para>
Despite these small problems, Bugzilla is very hard to beat. It
is under <emphasis>very</emphasis> active development to address
the current issues, and continually gains new features.
</para>
</section>
<section id="why">
@ -215,16 +191,8 @@ system against which all others are measured.
Throughout this portion of the Guide, we will refer to user
account options available at the Bugzilla test installation,
<ulink url="http://landfill.tequilarista.org/">
landfill.tequilarista.org</ulink>.
<note>
<para>
Some people have run into difficulties completing this
tutorial. If you run into problems, please check the
updated online documentation available at <ulink
url="http://www.trilobyte.net/barnsons/">http://www.trilobyte.net/barnsons</ulink>. If you're still stumped, please subscribe to the newsgroup and provide details of exactly what's stumping you! If enough people complain, I'll have to fix it in the next version of this Guide. You can subscribe to the newsgroup at <ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools"> news://news.mozilla.org/netscape.public.mozilla.webtools</ulink>
</para>
</note> Although Landfill serves as a great introduction to
landfill.tequilarista.org</ulink>.
Although Landfill serves as a great introduction to
Bugzilla, it does not offer all the options you would have as a
user on your own installation of Bugzilla, nor can it do more
than serve as a general introduction to Bugzilla. Additionally,
@ -236,7 +204,7 @@ system against which all others are measured.
<section id="myaccount">
<title>Create a Bugzilla Account</title>
<para>
First things first! If you want to use Bugzilla, first you
If you want to use Bugzilla, first you
need to create an account. Consult with the administrator
responsible for your installation of Bugzilla for the URL you
should use to access it. If you're test-driving the end-user
@ -282,19 +250,6 @@ system against which all others are measured.
that you can login.
</para>
</note>
<caution>
<para>
Many modern browsers include an
<quote>Auto-Complete</quote> or <quote>Form
Fill</quote> feature to remember the user names and
passwords you type in at many sites. Unfortunately,
sometimes they attempt to guess what you will put in
as your password, and guess wrong. If you notice a
text box is already filled out, please overwrite the
contents of the text box so you can be sure to input
the correct information.
</para>
</caution>
</para>
</listitem>
</orderedlist>
@ -317,16 +272,6 @@ system against which all others are measured.
Bugzilla system. We'll go into how to create your own bug
report later on.
</para>
<para>
There are efforts underway to simplify query usage. If you
have a local installation of Bugzilla 2.12 or higher, you
should have <filename>quicksearch.html</filename> available to
use and simplify your searches. There is also a helper for
the query interface, called
<filename>queryhelp.cgi</filename>. Landfill tends to run the
latest code, so these two utilities should be available there
for your perusal.
</para>
<para>
At this point, let's visit the query page.
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">

View File

@ -20,13 +20,13 @@
<!ENTITY revhistory SYSTEM "revhistory.sgml">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bz-ver "2.14">
<!ENTITY bz-cvs-ver "2.15">
<!ENTITY bzg-date "August 10, 2001">
<!ENTITY bzg-ver "2.14">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
<!ENTITY bz-ver "2.16">
<!ENTITY bz-cvs-ver "2.17">
<!ENTITY bzg-date "April 2nd, 2002">
<!ENTITY bzg-ver "2.16">
<!ENTITY bzg-cvs-ver "2.17.0">
<!ENTITY bzg-auth "The Bugzilla Team">
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">

View File

@ -6,13 +6,6 @@
<section id="aboutthisguide">
<title>Purpose and Scope of this Guide</title>
<para>
This document was started on September 17, 2000 by Matthew P.
Barnson after a great deal of procrastination updating the
Bugzilla FAQ, which I left untouched for nearly half a year.
After numerous complete rewrites and reformatting, it is the
document you see today.
</para>
<para>
Bugzilla is simply the best piece of bug-tracking software the
world has ever seen. This document is intended to be the
@ -43,20 +36,12 @@
digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
Got it? Good.
</para>
<para>
I wrote this in response to the enormous demand for decent
Bugzilla documentation. I have incorporated instructions from
the Bugzilla README, Frequently Asked Questions, Database Schema
Document, and various mailing lists to create it. Chances are,
there are glaring errors in this documentation; please contact
&bzg-auth-email; to correct them.
</para>
</section>
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
<attribution>Copyright (c) 2000-2001 &bzg-auth;</attribution>
<attribution>Copyright (c) 2000-2002 Matthew P. Barnson and &bzg-auth;</attribution>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
@ -64,7 +49,7 @@
Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and with no Back-Cover Texts. A copy of
the license is included in the section entitled "GNU Free
Documentation LIcense".
Documentation License".
</para>
</blockquote>
<para>
@ -94,7 +79,7 @@
</para>
<para>
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". I
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux in every situation
where it is appropriate. It is an extremely versatile, stable,
and robust operating system that offers an ideal operating
@ -103,8 +88,7 @@
<para>
You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter.
Heaven knows it's saved my bacon time after time; if you
implement any suggestion in this Guide, implement this one!
If you implement any suggestion in this Guide, implement this one!
</para>
<para>
Although the Bugzilla development team has taken great care to
@ -138,12 +122,7 @@
<itemizedlist>
<listitem>
<para>
<ulink url="http://www.trilobyte.net/barnsons/">TriloBYTE</ulink>
</para>
</listitem>
<listitem>
<para>
<ulink url="http://www.mozilla.org/projects/bugzilla/">Mozilla.org</ulink>
<ulink url="http://www.bugzilla.org/">bugzilla.org</ulink>
</para>
</listitem>
<listitem>
@ -157,7 +136,7 @@
<para>
The latest version of this document can be checked out via CVS.
Please follow the instructions available at <ulink
url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the mozilla/webtools/bugzilla/docs/ branch.
url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>, and check out the <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
</para>
</section>
@ -169,6 +148,10 @@
numerous e-mail and IRC support sessions, and overall excellent
contribution to the Bugzilla community:
</para>
<para>
<ulink url="mailto://mbarnson@sisna.com">Matthew P. Barnson</ulink>
for pulling together the Bugzilla Guide and shepherding it to 2.14.
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
for initially writing Bugzilla and creating the
@ -194,27 +177,13 @@
Last but not least, all the members of the <ulink
url="news://news.mozilla.org/netscape/public/mozilla/webtools"> netscape.public.mozilla.webtools</ulink> newsgroup. Without your discussions, insight, suggestions, and patches, this could never have happened.
</para>
</section>
<section id="contributors">
<title>Contributors</title>
<para>
Thanks go to these people for significant contributions to this
documentation (in no particular order):
Thanks also go to the following people for significant contributions
to this documentation (in no particular order):
</para>
<para>
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</para>
</section>
<section id="feedback">
<title>Feedback</title>
<para>
I welcome feedback on this document. Without your submissions
and input, this Guide cannot continue to exist. Please mail
additions, comments, criticisms, etc. to
<email>barnboy@trilobyte.net</email>. Please send flames to
<email>devnull@localhost</email>
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
</para>
</section>
@ -226,7 +195,7 @@
translate this Guide, please notify the members of the
mozilla-webtools mailing list at
<email>mozilla-webtools@mozilla.org</email>, and arrange with
Matt Barnson to check it into CVS.
&bzg-auth; to check it into CVS.
</para>
</section>

View File

@ -43,7 +43,7 @@ Tracking Systems", or, more commonly, "Bug-Tracking Systems". Defect
Tracking Systems allow individual or groups of developers to keep
track of outstanding bugs in their product effectively. Bugzilla was
originally written by Terry Weissman in a programming language called
"TCL", to replace a crappy bug-tracking database used internally for
"TCL", to replace a crappy bug-tracking database used internally by
Netscape Communications. Terry later ported Bugzilla to Perl from
TCL, and in Perl it remains to this day. Most commercial
defect-tracking software vendors at the time charged enormous
@ -87,7 +87,7 @@ system against which all others are measured.
</listitem>
<listitem>
<para>
email, XML, console, and HTTP APIs
email, XML, console, and web interfaces
</para>
</listitem>
<listitem>
@ -105,30 +105,6 @@ system against which all others are measured.
</listitem>
</itemizedlist>
</para>
<para>
Despite its current robustness and popularity, Bugzilla faces
some near-term challenges, such as reliance on a single
database, a lack of abstraction of the user interface and
program logic, verbose email bug notifications, a powerful but
daunting query interface, little reporting configurability,
problems with extremely large queries, some unsupportable bug
resolution options, little internationalization (although non-US
character sets are accepted for comments), and dependence on
some nonstandard libraries.
</para>
<para>
Some recent headway has been made on the query front, however.
If you are using the latest version of Bugzilla, you should see
a <quote>simple search</quote> form on the default front page of
your Bugzilla install. Type in two or three search terms and
you should pull up some relevant information. This is also
available as "queryhelp.cgi".
</para>
<para>
Despite these small problems, Bugzilla is very hard to beat. It
is under <emphasis>very</emphasis> active development to address
the current issues, and continually gains new features.
</para>
</section>
<section id="why">
@ -215,16 +191,8 @@ system against which all others are measured.
Throughout this portion of the Guide, we will refer to user
account options available at the Bugzilla test installation,
<ulink url="http://landfill.tequilarista.org/">
landfill.tequilarista.org</ulink>.
<note>
<para>
Some people have run into difficulties completing this
tutorial. If you run into problems, please check the
updated online documentation available at <ulink
url="http://www.trilobyte.net/barnsons/">http://www.trilobyte.net/barnsons</ulink>. If you're still stumped, please subscribe to the newsgroup and provide details of exactly what's stumping you! If enough people complain, I'll have to fix it in the next version of this Guide. You can subscribe to the newsgroup at <ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools"> news://news.mozilla.org/netscape.public.mozilla.webtools</ulink>
</para>
</note> Although Landfill serves as a great introduction to
landfill.tequilarista.org</ulink>.
Although Landfill serves as a great introduction to
Bugzilla, it does not offer all the options you would have as a
user on your own installation of Bugzilla, nor can it do more
than serve as a general introduction to Bugzilla. Additionally,
@ -236,7 +204,7 @@ system against which all others are measured.
<section id="myaccount">
<title>Create a Bugzilla Account</title>
<para>
First things first! If you want to use Bugzilla, first you
If you want to use Bugzilla, first you
need to create an account. Consult with the administrator
responsible for your installation of Bugzilla for the URL you
should use to access it. If you're test-driving the end-user
@ -282,19 +250,6 @@ system against which all others are measured.
that you can login.
</para>
</note>
<caution>
<para>
Many modern browsers include an
<quote>Auto-Complete</quote> or <quote>Form
Fill</quote> feature to remember the user names and
passwords you type in at many sites. Unfortunately,
sometimes they attempt to guess what you will put in
as your password, and guess wrong. If you notice a
text box is already filled out, please overwrite the
contents of the text box so you can be sure to input
the correct information.
</para>
</caution>
</para>
</listitem>
</orderedlist>
@ -317,16 +272,6 @@ system against which all others are measured.
Bugzilla system. We'll go into how to create your own bug
report later on.
</para>
<para>
There are efforts underway to simplify query usage. If you
have a local installation of Bugzilla 2.12 or higher, you
should have <filename>quicksearch.html</filename> available to
use and simplify your searches. There is also a helper for
the query interface, called
<filename>queryhelp.cgi</filename>. Landfill tends to run the
latest code, so these two utilities should be available there
for your perusal.
</para>
<para>
At this point, let's visit the query page.
<ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi">