Skip to content

bugzilla
bugzilla
Commit 3e7d0c08 authored by gerv%gerv.net's avatar gerv%gerv.net
Browse files
Options

Phase 1 of a big documentation update before 2.17.6.

parent d4be3230
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 116 additions and 271 deletions
docs/en/xml/Bugzilla-Guide.xml
View file @ 3e7d0c08
......@@ -13,7 +13,7 @@
<!ENTITY integration SYSTEM "integration.xml">
<!ENTITY future SYSTEM "future.xml">
<!ENTITY index SYSTEM "index.xml">
<!ENTITY database SYSTEM "database.xml">
<!ENTITY customization SYSTEM "customization.xml">
<!ENTITY patches SYSTEM "patches.xml">
<!ENTITY variants SYSTEM "variants.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
......@@ -32,13 +32,12 @@
For a devel release, simple bump bz-ver and bz-date
-->
<!ENTITY bz-ver "2.17.4">
<!ENTITY bz-ver "2.17.5">
<!ENTITY bz-nextver "2.18">
<!ENTITY bz-date "2003-04-23">
<!ENTITY bz-date "2004-01-15">
<!ENTITY % bz-devel "INCLUDE">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-auth "The Bugzilla Team">
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY newest-perl-ver "5.8">
......@@ -70,21 +69,23 @@
<!-- Coding standards for this document
* Other than the GFDL, please use the "section" tag instead of "sect1", "sect2", etc.
* Other than the GFDL, please use the "section" tag instead of "sect1",
"sect2", etc.
* Use Entities to include files for new chapters in Bugzilla-Guide.xml.
* Try to use Entities for frequently-used passages of text as well.
* Ensure all documents compile cleanly to HTML after modification.
The warning, "DTDDECL catalog types not supported" is normal.
The warning, "DTDDECL catalog types not supported" is normal.
* Try to index important terms wherever possible.
* Use "glossterm" whenever you introduce a new term.
* Follow coding standards at http://www.tldp.org, and
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
check out the KDE guidelines (they are nice, too)
http://i18n.kde.org/doc/markup.html
* All tags should be lowercase.
* Please use sensible spacing. The comments at the very end of each
file define reasonable defaults for PSGML mode in EMACS.
Double-indent tags, use double spacing whenever possible, and
try to avoid clutter and feel free to waste space in the code to make it more readable.
file define reasonable defaults for PSGML mode in EMACS.
* Double-indent tags, use double spacing whenever possible, and
try to avoid clutter and feel free to waste space in the code to make it
more readable.
-->
......@@ -93,18 +94,10 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Header -->
<bookinfo>
<title>The Bugzilla Guide - &bz-ver; <![%bz-devel;[Development ]]>Release</title>
<title>The Bugzilla Guide - &bz-ver;
<![%bz-devel;[Development ]]>Release</title>
<authorgroup>
<author>
<firstname>Matthew</firstname>
<othername>P.</othername>
<surname>Barnson</surname>
</author>
<author>
<firstname>Jacob</firstname>
<surname>Steenhagen</surname>
</author>
<corpauthor>The Bugzilla Team</corpauthor>
</authorgroup>
......@@ -112,24 +105,19 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<abstract>
<para>
This is the documentation for Bugzilla, the mozilla.org
bug-tracking system.
This is the documentation for Bugzilla, a
bug-tracking system from mozilla.org.
Bugzilla is an enterprise-class piece of software
that powers issue-tracking for hundreds of
organizations around the world, tracking millions of bugs.
that tracks millions of bugs and issues for hundreds of
organizations around the world.
</para>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the &bzg-bugs; component.
<para>
The most current version of this document can always be found on the
<ulink url="http://www.bugzilla.org/documentation.html">Bugzilla
Documentation Page</ulink>.
</para>
<![%bz-devel;[
<para>This is a development version of this guide. Information in it
is subject to change before the &bz-nextver; release of this guide
(which will correspond with the &bz-nextver; release of Bugzilla).
</para>
]]>
</abstract>
<keywordset>
......@@ -160,18 +148,15 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Administering Bugzilla -->
&administration;
<!-- Customizing Bugzilla -->
&customization;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Custom Patches -->
&patches;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Appendix: GNU Free Documentation License -->
&gfdl;
......
docs/en/xml/about.xml
View file @ 3e7d0c08
......@@ -7,7 +7,7 @@
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
<attribution>Copyright (c) 2000-2003 Matthew P. Barnson and &bzg-auth;</attribution>
<attribution>Copyright (c) 2000-2004 The Bugzilla Team</attribution>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
......@@ -20,7 +20,7 @@
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;.
please contact the Bugzilla Team.
</para>
</section>
......@@ -28,7 +28,7 @@
<title>Disclaimer</title>
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
......@@ -36,35 +36,20 @@
war. Proceed with caution.
</para>
<para>
All copyrights are held by their respective owners, unless
specifically noted otherwise. Use of a term in this document
should not be regarded as affecting the validity of any
trademark or service mark.
</para>
<para>
Naming of particular products or brands should not be seen as
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,
wholeheartedly endorse the use of GNU/Linux; it is an extremely
versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</para>
<para>
You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter.
If you implement any suggestion in this Guide, implement this one!
</para>
<para>
Although the Bugzilla development team has taken great care to
ensure that all easily-exploitable bugs or options are
documented or fixed in the code, security holes surely exist.
Great care should be taken both in the installation and usage of
this software. Carefully consider the implications of installing
other network services with Bugzilla. The Bugzilla development
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
product, and are responsible for auditing it yourself to ensure
ensure that all exploitable bugs or options have been
fixed, security holes surely exist. Great care should be taken both in
the installation and usage of this software. The Bugzilla development
team members assume no liability for your use of this software. You have
the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
......@@ -77,24 +62,14 @@
This is the &bz-ver; version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
<![%bz-devel;[
This version of the guide, like its associated Bugzilla version is a
development version. Information is subject to change between now and
when &bz-nextver; is released.
This version of the guide, like its associated Bugzilla version, is a
development version.
]]>
If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
</para>
<para>
The newest version of this guide can always be found at <ulink
url="http://www.bugzilla.org"/>; including
documentation for past releases and the current development version.
</para>
<para>
The documentation for the most recent stable release of Bugzilla can also
be found at
<ulink url="http://www.tldp.org">The Linux Documentation Project</ulink>.
url="http://www.bugzilla.org"/>; however, you should read the version
which came with the Bugzilla release you are using.
</para>
<para>
The latest version of this document can always be checked out via CVS.
......@@ -118,87 +93,33 @@
contribution to the Bugzilla community:
</para>
<!-- TODO: This is evil... there has to be a valid way to get this look -->
<variablelist>
<varlistentry>
<term>Matthew P. Barnson <email>mbarnson@sisna.com</email></term>
<listitem>
<para>for the Herculaean task of pulling together the Bugzilla Guide
and shepherding it to 2.14.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Terry Weissman <email>terry@mozilla.org</email></term>
<listitem>
<para>for initially writing Bugzilla and creating the README upon
which the UNIX installation documentation is largely based.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tara Hernandez <email>tara@tequilarists.org</email></term>
<listitem>
<para>for keeping Bugzilla development going strong after Terry left
mozilla.org and for running landfill.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
<listitem>
<para>for providing insight into the key differences between Red
Hat's customized Bugzilla, and being largely responsible for
<xref linkend="variant-redhat"/>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dawn Endico <email>endico@mozilla.org</email></term>
<listitem>
<para>for being a hacker extraordinaire and putting up with Matthew's
incessant questions and arguments on irc.mozilla.org in #mozwebtools
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Jacob Steenhagen <email>jake@bugzilla.org</email></term>
<listitem>
<para>for taking over documentation during the 2.17 development
period.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Last but not least, all the members of the
<ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"/>
newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened.
</para>
<para>
Thanks also go to the following people for significant contributions
to this documentation (in alphabetical order):
<simplelist type="inline">
<member>Andrew Pearson</member>
<member>Matthew P. Barnson</member>
<member>Kevin Brannen</member>
<member>Dawn Endico</member>
<member>Ben FrantzDale</member>
<member>Eric Hanson</member>
<member>Tara Hernandez</member>
<member>Dave Lawrence</member>
<member>Zach Lipton</member>
<member>Gervase Markham</member>
<member>Andrew Pearson</member>
<member>Joe Robins</member>
<member>Kevin Brannen</member>
<member>Martin Wulffeld</member>
<member>Ron Teitelbaum</member>
<member>Spencer Smith</member>
<member>Zach Liption</member>
</simplelist>
.
<member>Jacob Steenhagen</member>
<member>Ron Teitelbaum</member>
<member>Terry Weissman</member>
<member>Martin Wulffeld</member>
</simplelist>.
</para>
<para>
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>
......
docs/en/xml/conventions.xml
View file @ 3e7d0c08
......@@ -60,7 +60,7 @@
</row>
<row>
<entry>File Names</entry>
<entry>File and directory names</entry>
<entry>
<filename>filename</filename>
......@@ -68,14 +68,6 @@
</row>
<row>
<entry>Directory Names</entry>
<entry>
<filename class="directory">directory</filename>
</entry>
</row>
<row>
<entry>Commands to be typed</entry>
<entry>
......@@ -84,7 +76,7 @@
</row>
<row>
<entry>Applications Names</entry>
<entry>Applications names</entry>
<entry>
<application>application</application>
......@@ -119,7 +111,7 @@
</row>
<row>
<entry>Environment Variables</entry>
<entry>Environment variables</entry>
<entry>
<envar>VARIABLE</envar>
......@@ -127,14 +119,6 @@
</row>
<row>
<entry>Emphasized word</entry>
<entry>
<emphasis>word</emphasis>
</entry>
</row>
<row>
<entry>Term found in the glossary</entry>
<entry>
......@@ -143,7 +127,7 @@
</row>
<row>
<entry>Code Example</entry>
<entry>Code example</entry>
<entry>
<programlisting><sgmltag class="starttag">para</sgmltag>
......@@ -154,6 +138,13 @@ Beginning and end of paragraph
</tbody>
</tgroup>
</informaltable>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the &bzg-bugs; component.
</para>
</section>
<!-- Keep this comment at the end of the file
......
docs/en/xml/integration.xml
View file @ 3e7d0c08
......@@ -70,7 +70,12 @@
xreflabel="Tinderbox, the Mozilla automated build management system">
<title>Tinderbox/Tinderbox2</title>
<para>We need Tinderbox integration information.</para>
<para>Tinderbox is a continuous-build system which can integrate with
Bugzilla - see
<ulink url="http://www.mozilla.org/projects/tinderbox"/> for details
of Tinderbox, and
<ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it
in action.</para>
</section>
</section>
......
docs/en/xml/introduction.xml
View file @ 3e7d0c08
<chapter id="introduction">
<title>Introduction</title>
<section id="whatis">
<section id="what-is-bugzilla">
<title>What is Bugzilla?</title>
<para>
Bugzilla is a bug- or issue-tracking system. Bug-tracking
systems allow individual or groups of developers effectively to keep track
of outstanding problems with their product.
Bugzilla was originally
written by Terry Weissman in a programming language called TCL, to
replace a rudimentary 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 licensing fees, and Bugzilla quickly became
a favorite of the open-source crowd (with its genesis in the open-source
browser project, Mozilla). It is now the de-facto standard
defect-tracking system against which all others are measured.
of outstanding problems with their products.
</para>
<para><emphasis>Do we need more here?</emphasis></para>
</section>
<section id="why-tracking">
<title>Why use a bug-tracking system?</title>
<para>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.</para>
<para>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.</para>
</section>
<section id="why-bugzilla">
<title>Why use Bugzilla?</title>
<para>Bugzilla boasts many advanced features. These include:
<itemizedlist>
......@@ -71,34 +92,7 @@
</listitem>
</itemizedlist>
</para>
</section>
<section id="why">
<title>Why Should We Use Bugzilla?</title>
<para>For many years, defect-tracking software has remained principally
the domain of large software development houses. Even then, most shops
never bothered with bug-tracking software, and instead simply relied on
shared lists and email to monitor the status of defects. This procedure
is error-prone and tends to cause those bugs judged least significant by
developers to be dropped or ignored.</para>
<para>These days, many companies are finding that integrated
defect-tracking systems reduce downtime, increase productivity, and raise
customer satisfaction with their systems. Along with full disclosure, an
open bug-tracker allows manufacturers to keep in touch with their 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 system for accounting for unusual system or software
issues.</para>
<para>But why should
<emphasis>you</emphasis>
use Bugzilla?</para>
<para>Bugzilla is very adaptable to various situations. Known uses
currently include IT support queues, Systems Administration deployment
management, chip design and development problem tracking (both
......@@ -110,20 +104,6 @@
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
provides a powerful, easy-to-use solution to configuration management and
replication problems.</para>
<para>Bugzilla can dramatically increase the productivity and
accountability of individual employees by providing a documented workflow
and positive feedback for good performance. How many times do you wake up
in the morning, remembering that you were supposed to do
<emphasis>something</emphasis>
today, but you just can't quite remember? Put it in Bugzilla, and you
have a record of it from which you can extrapolate milestones, predict
product versions for integration, and follow the discussion trail
that led to critical decisions.</para>
<para>Ultimately, Bugzilla puts the power in your hands to improve your
value to your employer or business while providing a usable framework for
your natural attention to detail and knowledge store to flourish.</para>
</section>
</chapter>
......
docs/en/xml/patches.xml
View file @ 3e7d0c08
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Useful Patches and Utilities for Bugzilla</title>
<title>Contrib</title>
<para>Are you looking for a way to put your Bugzilla into overdrive? Catch
some of the niftiest tricks here in this section.</para>
<section id="rewrite" xreflabel="Apache mod_rewrite magic">
<title>Apache
<filename>mod_rewrite</filename>
magic</title>
<para>Apache's
<filename>mod_rewrite</filename>
module lets you do some truly amazing things with URL rewriting. Here are
a couple of examples of what you can do.</para>
<orderedlist>
<listitem>
<para>Make it so if someone types
<computeroutput>http://www.foo.com/12345</computeroutput>
, Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try
setting up your VirtualHost section for Bugzilla with a rule like
this:</para>
<programlisting><![CDATA[
<VirtualHost 12.34.56.78>
RewriteEngine On
RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</VirtualHost>
]]></programlisting>
</listitem>
<listitem>
<para>There are many, many more things you can do with mod_rewrite.
Please refer to the mod_rewrite documentation at
<ulink url="http://www.apache.org"/>.
</para>
</listitem>
</orderedlist>
</section>
<para>There are a number of unofficial Bugzilla add-ons in the
<filename class="directory">$BUGZILLA_ROOT/contrib/</filename>
directory. This section documents them.</para>
<section id="cmdline">
<title>Command-line Bugzilla Queries</title>
<title>Command-line Search Interface</title>
<para>There are a suite of Unix utilities for querying Bugzilla from the
<para>There are a suite of Unix utilities for searching Bugzilla from the
command line. They live in the
<filename class="directory">contrib/cmdline</filename>
directory. However, they
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment