diff options
| -rw-r--r-- | docs/en/xml/Bugzilla-Guide.xml | 153 | ||||
| -rw-r--r-- | docs/en/xml/installation.xml | 95 |
2 files changed, 144 insertions, 104 deletions
diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml index d6ff02c20..f0811db70 100644 --- a/docs/en/xml/Bugzilla-Guide.xml +++ b/docs/en/xml/Bugzilla-Guide.xml @@ -1,89 +1,96 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [ +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ <!-- Include macros --> -<!ENTITY about SYSTEM "about.sgml"> -<!ENTITY conventions SYSTEM "conventions.sgml"> -<!ENTITY doc-index SYSTEM "index.sgml"> -<!ENTITY faq SYSTEM "faq.sgml"> -<!ENTITY gfdl SYSTEM "gfdl.sgml"> -<!ENTITY glossary SYSTEM "glossary.sgml"> -<!ENTITY installation SYSTEM "installation.sgml"> -<!ENTITY administration SYSTEM "administration.sgml"> -<!ENTITY using SYSTEM "using.sgml"> -<!ENTITY integration SYSTEM "integration.sgml"> -<!ENTITY future SYSTEM "future.sgml"> -<!ENTITY index SYSTEM "index.sgml"> -<!ENTITY database SYSTEM "database.sgml"> -<!ENTITY patches SYSTEM "patches.sgml"> -<!ENTITY variants SYSTEM "variants.sgml"> -<!ENTITY introduction SYSTEM "introduction.sgml"> -<!ENTITY revhistory SYSTEM "revhistory.sgml"> +<!ENTITY about SYSTEM "about.xml"> +<!ENTITY conventions SYSTEM "conventions.xml"> +<!ENTITY doc-index SYSTEM "index.xml"> +<!ENTITY faq SYSTEM "faq.xml"> +<!ENTITY gfdl SYSTEM "gfdl.xml"> +<!ENTITY glossary SYSTEM "glossary.xml"> +<!ENTITY installation SYSTEM "installation.xml"> +<!ENTITY administration SYSTEM "administration.xml"> +<!ENTITY security SYSTEM "security.xml"> +<!ENTITY using SYSTEM "using.xml"> +<!ENTITY integration SYSTEM "integration.xml"> +<!ENTITY index SYSTEM "index.xml"> +<!ENTITY customization SYSTEM "customization.xml"> +<!ENTITY troubleshooting SYSTEM "troubleshooting.xml"> +<!ENTITY patches SYSTEM "patches.xml"> +<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY modules SYSTEM "modules.xml"> <!-- Things to change for a stable release: * bz-ver to current stable * bz-nexver to next stable * bz-date to the release date - * bz-devel to "IGNORE" + * Remove the BZ-DEVEL comments - COMPILE DOCS AND CHECKIN - Also, tag and tarball before completing * bz-ver to devel version - * bz-devel to "INCLUDE" For a devel release, simple bump bz-ver and bz-date --> -<!ENTITY bz-ver "2.17.4"> -<!ENTITY bz-nextver "2.18"> -<!ENTITY bz-date "2003-02-16"> -<!ENTITY % bz-devel "INCLUDE"> +<!ENTITY bz-ver "2.19.3"> +<!ENTITY bz-nextver "2.20"> +<!ENTITY bz-date "2005-05-11"> +<!ENTITY current-year "2005"> +<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/"> <!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&component=Documentation'>Bugzilla Documentation</ulink>"> <!ENTITY mysql "http://www.mysql.com/"> -<!ENTITY newest-perl-ver "5.8"> +<!ENTITY newest-perl-ver "5.8.3"> <!-- For minimum versions --> <!ENTITY min-mysql-ver "3.23.41"> -<!ENTITY min-perl-ver "5.6"> +<!ENTITY min-pg-ver "7.3.x"> +<!ENTITY min-perl-ver "5.6.1"> +<!ENTITY min-perl-ver-win "5.8.1"> <!ENTITY min-template-ver "2.08"> -<!ENTITY min-file-temp-ver "1.804"> +<!ENTITY min-file-temp-ver "any"> <!ENTITY min-appconfig-ver "1.52"> <!ENTITY min-text-wrap-ver "2001.0131"> <!ENTITY min-file-spec-ver "0.82"> <!ENTITY min-data-dumper-ver "any"> -<!ENTITY min-dbd-mysql-ver "2.1010"> -<!ENTITY min-dbi-ver "1.32"> -<!ENTITY min-date-parse-ver "any"> -<!ENTITY min-cgi-ver "2.88"> +<!ENTITY min-dbd-mysql-ver "2.9003"> +<!ENTITY min-dbd-pg-ver "1.31"> +<!ENTITY min-dbi-ver "1.38"> +<!ENTITY min-date-format-ver "2.21"> +<!ENTITY min-cgi-ver "2.93"> +<!ENTITY min-mail-mailer-ver "1.65"> +<!ENTITY min-storable-ver "any"> <!-- Optional modules --> <!ENTITY min-gd-ver "1.20"> <!ENTITY min-gd-graph-ver "any"> <!ENTITY min-gd-text-align-ver "any"> -<!ENTITY min-chart-base-ver "0.99c"> +<!ENTITY min-chart-base-ver "1.0"> <!ENTITY min-xml-parser-ver "any"> <!ENTITY min-mime-parser-ver "any"> +<!ENTITY min-patchreader-ver "0.9.4"> ]> <!-- Coding standards for this document -* 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.sgml. +* 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 -* All tags should be lowercase (needsfix) + 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. --> @@ -92,18 +99,11 @@ 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 <!-- /BZ-DEVEL --> + 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> @@ -111,24 +111,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 SGML diffs, attached - to a bug filed in the &bzg-bugs; compontent. + <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> @@ -147,29 +142,32 @@ try to avoid clutter and feel free to waste space in the code to make it more re <!-- About This Guide --> &about; -<!-- Introduction --> -&introduction; - -<!-- Using Bugzilla --> -&using; - <!-- Installing Bugzilla --> &installation; <!-- Administering Bugzilla --> &administration; +<!-- Securing Bugzilla --> +&security; + +<!-- Customizing Bugzilla --> +&customization; + +<!-- Using Bugzilla --> +&using; + <!-- Appendix: The Frequently Asked Questions --> &faq; -<!-- Appendix: The Database Schema --> -&database; +<!-- Appendix: Troubleshooting --> +&troubleshooting; <!-- Appendix: Custom Patches --> &patches; -<!-- Appendix: Major Bugzilla Variants --> -&variants; +<!-- Appendix: Manually Installing Perl Modules --> +&modules; <!-- Appendix: GNU Free Documentation License --> &gfdl; @@ -198,8 +196,9 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml index 6446c70bd..b7e5b476b 100644 --- a/docs/en/xml/installation.xml +++ b/docs/en/xml/installation.xml @@ -1,5 +1,5 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> -<!-- $Id: installation.xml,v 1.93 2008/04/04 06:47:23 mozilla%colinogilvie.co.uk Exp $ --> +<!-- $Id: installation.xml,v 1.94 2008/04/04 06:47:24 mozilla%colinogilvie.co.uk Exp $ --> <chapter id="installing-bugzilla"> <title>Installing Bugzilla</title> @@ -59,8 +59,7 @@ </para> </step> <step> - <para><link linkend="install-mysql">Install MySQL</link> - (&min-mysql-ver; or above) + <para><link linkend="install-database">Install a Database Engine</link> </para> </step> <step> @@ -100,33 +99,57 @@ As of this writing, that is Perl &newest-perl-ver;.</para> </section> - <section id="install-mysql"> - <title>MySQL</title> + <section id="install-database"> + <title>Database Engine</title> + + <para>From Bugzilla 2.20, support is included for using both the MySQL and + PostgreSQL database servers. You only require one of these systems to make + use of Bugzilla.</para> - <para>Installed Version Test: <filename>mysql -V</filename></para> + <section id="install-mysql"> + <title>MySQL</title> + <para>Installed Version Test: <filename>mysql -V</filename></para> - <para> - If you don't have it and your OS doesn't provide official packages, - visit <ulink url="http://www.mysql.com"/>. You need MySQL version - &min-mysql-ver; or higher. - </para> + <para> + If you don't have it and your OS doesn't provide official packages, + visit <ulink url="http://www.mysql.com"/>. You need MySQL version + &min-mysql-ver; or higher. + </para> - <note> - <para> Many of the binary - versions of MySQL store their data files in - <filename class="directory">/var</filename>. - On some Unix systems, this is part of a smaller root partition, - and may not have room for your bug database. To change the data - directory, you have to build MySQL from source yourself, and - set it as an option to <filename>configure</filename>.</para> - </note> + <note> + <para> Many of the binary + versions of MySQL store their data files in + <filename class="directory">/var</filename>. + On some Unix systems, this is part of a smaller root partition, + and may not have room for your bug database. To change the data + directory, you have to build MySQL from source yourself, and + set it as an option to <filename>configure</filename>.</para> + </note> - <para>If you install from something other than a packaging/installation - system, such as .rpm (Redhat Package), .deb (Debian Package), .exe - (Windows Executable), or .msi (Microsoft Installer), make sure the MySQL - server is started when the machine boots. - </para> - + <para>If you install from something other than a packaging/installation + system, such as .rpm (Redhat Package), .deb (Debian Package), .exe + (Windows Executable), or .msi (Microsoft Installer), make sure the MySQL + server is started when the machine boots. + </para> + </section> + + <section id="install-pg"> + <title>PostgreSQL</title> + <para>Installed Version Test: <filename>psql -V</filename></para> + + <para> + If you don't have it and your OS doesn't provide official packages, + visit <ulink url="http://www.postgresql.org/"/>. You need PostgreSQL + version &min-pg-ver; or higher. + </para> + + <para>If you install from something other than a packaging/installation + system, such as .rpm (Redhat Package), .deb (Debian Package), .exe + (Windows Executable), or .msi (Microsoft Installer), make sure the + PostgreSQL server is started when the machine boots. + </para> + </section> + </section> <section id="install-webserver"> @@ -301,7 +324,13 @@ <listitem> <para> <link linkend="install-modules-dbd-mysql">DBD::mysql</link> - (&min-dbd-mysql-ver;) + (&min-dbd-mysql-ver;) if using MySQL + </para> + </listitem> + + <listitem> + <para> + DBD::Pg (&min-dbd-pg-ver;) if using PostgreSQL </para> </listitem> @@ -329,6 +358,18 @@ Text::Wrap (&min-text-wrap-ver;) </para> </listitem> + + <listitem> + <para> + Mail::Mailer (&min-mail-mailer-ver;) + </para> + </listitem> + + <listitem> + <para> + Storable (&min-storable-ver;) + </para> + </listitem> </orderedlist> Optional Perl modules: |