From 332ea83af448079b894e6d1f9065138148f24a7d Mon Sep 17 00:00:00 2001 From: "gerv%gerv.net" <> Date: Thu, 2 May 2002 06:48:32 +0000 Subject: General updates. I'm working through the entire guide, tidying it up. --- docs/sgml/Bugzilla-Guide.sgml | 14 +++++----- docs/sgml/about.sgml | 61 ++++++++++------------------------------ docs/sgml/using.sgml | 65 ++++--------------------------------------- docs/xml/Bugzilla-Guide.xml | 14 +++++----- docs/xml/about.xml | 61 ++++++++++------------------------------ docs/xml/using.xml | 65 ++++--------------------------------------- 6 files changed, 54 insertions(+), 226 deletions(-) (limited to 'docs') diff --git a/docs/sgml/Bugzilla-Guide.sgml b/docs/sgml/Bugzilla-Guide.sgml index e639ae75f..bd0b3a4a1 100644 --- a/docs/sgml/Bugzilla-Guide.sgml +++ b/docs/sgml/Bugzilla-Guide.sgml @@ -20,13 +20,13 @@ - - - - - - -barnboy@trilobyte.net"> + + + + + + +Bugzilla"> diff --git a/docs/sgml/about.sgml b/docs/sgml/about.sgml index 04e054bc2..62e486573 100644 --- a/docs/sgml/about.sgml +++ b/docs/sgml/about.sgml @@ -6,13 +6,6 @@
Purpose and Scope of this Guide - - 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. - 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. - - 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. -
@@ -169,6 +148,10 @@ numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: + + Matthew P. Barnson + for pulling together the Bugzilla Guide and shepherding it to 2.14. + Terry Weissman for initially writing Bugzilla and creating the @@ -194,27 +177,13 @@ 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. - - -
-Contributors - 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): - Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron - Teitelbaum, Jacob Steenhagen, Joe Robins - -
-
- Feedback - - I welcome feedback on this document. Without your submissions - and input, this Guide cannot continue to exist. Please mail - additions, comments, criticisms, etc. to - barnboy@trilobyte.net. Please send flames to - devnull@localhost + Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, + Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
@@ -226,7 +195,7 @@ translate this Guide, please notify the members of the mozilla-webtools mailing list at mozilla-webtools@mozilla.org, and arrange with - Matt Barnson to check it into CVS. + &bzg-auth; to check it into CVS. diff --git a/docs/sgml/using.sgml b/docs/sgml/using.sgml index 80ecb5c0b..6cb301d61 100644 --- a/docs/sgml/using.sgml +++ b/docs/sgml/using.sgml @@ -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. - email, XML, console, and HTTP APIs + email, XML, console, and web interfaces @@ -105,30 +105,6 @@ system against which all others are measured. - - 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. - - - Some recent headway has been made on the query front, however. - If you are using the latest version of Bugzilla, you should see - a simple search 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". - - - Despite these small problems, Bugzilla is very hard to beat. It - is under very active development to address - the current issues, and continually gains new features. -
@@ -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, - landfill.tequilarista.org. - - - Some people have run into difficulties completing this - tutorial. If you run into problems, please check the - updated online documentation available at http://www.trilobyte.net/barnsons. 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 news://news.mozilla.org/netscape.public.mozilla.webtools - - - Although Landfill serves as a great introduction to + landfill.tequilarista.org. + 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.
Create a Bugzilla Account - 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. - - - Many modern browsers include an - Auto-Complete or Form - Fill 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. - - @@ -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. - - There are efforts underway to simplify query usage. If you - have a local installation of Bugzilla 2.12 or higher, you - should have quicksearch.html available to - use and simplify your searches. There is also a helper for - the query interface, called - queryhelp.cgi. Landfill tends to run the - latest code, so these two utilities should be available there - for your perusal. - At this point, let's visit the query page. diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml index e639ae75f..bd0b3a4a1 100644 --- a/docs/xml/Bugzilla-Guide.xml +++ b/docs/xml/Bugzilla-Guide.xml @@ -20,13 +20,13 @@ - - - - - - -barnboy@trilobyte.net"> + + + + + + +Bugzilla"> diff --git a/docs/xml/about.xml b/docs/xml/about.xml index 04e054bc2..62e486573 100644 --- a/docs/xml/about.xml +++ b/docs/xml/about.xml @@ -6,13 +6,6 @@
Purpose and Scope of this Guide - - 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. - 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. - - 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. -
@@ -169,6 +148,10 @@ numerous e-mail and IRC support sessions, and overall excellent contribution to the Bugzilla community: + + Matthew P. Barnson + for pulling together the Bugzilla Guide and shepherding it to 2.14. + Terry Weissman for initially writing Bugzilla and creating the @@ -194,27 +177,13 @@ 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. -
- -
-Contributors - 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): - Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron - Teitelbaum, Jacob Steenhagen, Joe Robins - -
-
- Feedback - - I welcome feedback on this document. Without your submissions - and input, this Guide cannot continue to exist. Please mail - additions, comments, criticisms, etc. to - barnboy@trilobyte.net. Please send flames to - devnull@localhost + Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, + Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
@@ -226,7 +195,7 @@ translate this Guide, please notify the members of the mozilla-webtools mailing list at mozilla-webtools@mozilla.org, and arrange with - Matt Barnson to check it into CVS. + &bzg-auth; to check it into CVS.
diff --git a/docs/xml/using.xml b/docs/xml/using.xml index 80ecb5c0b..6cb301d61 100644 --- a/docs/xml/using.xml +++ b/docs/xml/using.xml @@ -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. - email, XML, console, and HTTP APIs + email, XML, console, and web interfaces @@ -105,30 +105,6 @@ system against which all others are measured. - - 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. - - - Some recent headway has been made on the query front, however. - If you are using the latest version of Bugzilla, you should see - a simple search 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". - - - Despite these small problems, Bugzilla is very hard to beat. It - is under very active development to address - the current issues, and continually gains new features. -
@@ -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, - landfill.tequilarista.org. - - - Some people have run into difficulties completing this - tutorial. If you run into problems, please check the - updated online documentation available at http://www.trilobyte.net/barnsons. 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 news://news.mozilla.org/netscape.public.mozilla.webtools - - - Although Landfill serves as a great introduction to + landfill.tequilarista.org. + 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.
Create a Bugzilla Account - 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. - - - Many modern browsers include an - Auto-Complete or Form - Fill 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. - - @@ -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. - - There are efforts underway to simplify query usage. If you - have a local installation of Bugzilla 2.12 or higher, you - should have quicksearch.html available to - use and simplify your searches. There is also a helper for - the query interface, called - queryhelp.cgi. Landfill tends to run the - latest code, so these two utilities should be available there - for your perusal. - At this point, let's visit the query page. -- cgit v1.2.3-24-g4f1b