summaryrefslogtreecommitdiffstats
path: root/docs/en
diff options
context:
space:
mode:
authorjake%bugzilla.org <>2008-04-04 13:47:17 +0200
committerjake%bugzilla.org <>2008-04-04 13:47:17 +0200
commiteb50b5abb6bc14f705c4794b34c7c573739afd40 (patch)
treec1098a93260513faa58495b78b059698c6b60ea3 /docs/en
parent09962dd12d30d488c0105afcac1e541c0475ab62 (diff)
downloadbugzilla-eb50b5abb6bc14f705c4794b34c7c573739afd40.tar.gz
bugzilla-eb50b5abb6bc14f705c4794b34c7c573739afd40.tar.xz
Update links to tldp.org and Bugzilla version numbers. Also, added some text ab
out this being a development version of the guide and instructions on what to ch ange for a release (including how to disable the devel text).
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/xml/Bugzilla-Guide.xml33
-rw-r--r--docs/en/xml/about.xml130
2 files changed, 74 insertions, 89 deletions
diff --git a/docs/en/xml/Bugzilla-Guide.xml b/docs/en/xml/Bugzilla-Guide.xml
index 015aed327..a76d2c090 100644
--- a/docs/en/xml/Bugzilla-Guide.xml
+++ b/docs/en/xml/Bugzilla-Guide.xml
@@ -19,12 +19,25 @@
<!ENTITY introduction SYSTEM "introduction.sgml">
<!ENTITY revhistory SYSTEM "revhistory.sgml">
+<!-- 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"
+ - COMPILE DOCS AND CHECKIN -
+ Also, tag and tarball at 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.3">
+<!ENTITY bz-nextver "2.18">
+<!ENTITY bz-date "2003-01-02">
+<!ENTITY % bz-devel "INCLUDE">
+
<!ENTITY bz "http://www.bugzilla.org/">
-<!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/">
@@ -63,7 +76,7 @@
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.linuxdoc.org, and
+* 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)
@@ -94,6 +107,8 @@ try to avoid clutter and feel free to waste space in the code to make it more re
</author>
</authorgroup>
+ <pubdate>&bz-date;</pubdate>
+
<abstract>
<para>
This is the documentation for Bugzilla, the mozilla.org
@@ -109,6 +124,12 @@ try to avoid clutter and feel free to waste space in the code to make it more re
to a bug filed in
<ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation">mozilla.org's Bugzilla</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>
diff --git a/docs/en/xml/about.xml b/docs/en/xml/about.xml
index 62e486573..219d529e1 100644
--- a/docs/en/xml/about.xml
+++ b/docs/en/xml/about.xml
@@ -4,40 +4,6 @@
<chapter id="about">
<title>About This Guide</title>
- <section id="aboutthisguide">
- <title>Purpose and Scope of this Guide</title>
- <para>
- Bugzilla is simply the best piece of bug-tracking software the
- world has ever seen. This document is intended to be the
- comprehensive guide to the installation, administration,
- maintenance, and use of the Bugzilla bug-tracking system.
- </para>
- <para>
- This release of the Bugzilla Guide is the
- <emphasis>&bzg-ver;</emphasis> release. It is so named that it
- may match the current version of Bugzilla. The numbering
- tradition stems from that used for many free software projects,
- in which <emphasis>even-numbered</emphasis> point releases (1.2,
- 1.14, etc.) are considered "stable releases", intended for
- public consumption; on the other hand,
- <emphasis>odd-numbered</emphasis> point releases (1.3, 2.09,
- etc.) are considered unstable <emphasis>development</emphasis>
- releases intended for advanced users, systems administrators,
- developers, and those who enjoy a lot of pain.
- </para>
- <para>
- Newer revisions of the Bugzilla Guide follow the numbering
- conventions of the main-tree Bugzilla releases, available at
- <ulink url="&bz;">&bz;</ulink>. Intermediate releases will have
- a minor revision number following a period. The current version
- of Bugzilla, as of this writing (&bzg-date;) is &bz-ver;; if
- something were seriously wrong with that edition of the Guide,
- subsequent releases would receive an additional dotted-decimal
- digit to indicate the update (&bzg-ver;.1, &bzg-ver;.2, etc.).
- Got it? Good.
- </para>
- </section>
-
<section id="copyright">
<title>Copyright Information</title>
<blockquote>
@@ -48,8 +14,7 @@
License, Version 1.1 or any later version published by the
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".
+ the license is included below.
</para>
</blockquote>
<para>
@@ -57,6 +22,11 @@
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;.
</para>
+
+
+ <!-- The GNU Free Documentation License -->
+ &gfdl;
+
</section>
<section id="disclaimer">
@@ -64,12 +34,11 @@
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
- As this is a new edition of this document, there may be errors
- and inaccuracies that may damage your system. Use of this
- document may cause your girlfriend to leave you, your cats to
- pee on your furniture and clothing, your computer to cease
- functioning, your boss to fire you, and global thermonuclear
- war. Proceed with caution.
+ 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
+ pee on your furniture and clothing, and global thermonuclear
+ war. Proceed with caution.
</para>
<para>
All copyrights are held by their respective owners, unless
@@ -100,7 +69,7 @@
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 insure
+ product, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
@@ -110,33 +79,39 @@
<section id="newversions">
<title>New Versions</title>
<para>
- This is the &bzg-ver; version of The Bugzilla Guide. If you are
+ 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.
+ ]]>
+ 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>
- This document can be found in the following places:
+ The newest version of this guide can always be found at <ulink
+ url="http://www.bugzilla.org">bugzilla.org</ulink>; including
+ documentation for past releases and the current development version.
</para>
<para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.bugzilla.org/">bugzilla.org</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- <ulink url="http://www.linuxdoc.org/">The Linux
- Documentation Project</ulink>
- </para>
- </listitem>
- </itemizedlist>
+ 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>.
</para>
<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 <filename>mozilla/webtools/bugzilla/docs/</filename> branch.
+ The latest version of this document can always 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 <filename>mozilla/webtools/bugzilla/docs/</filename>
+ subtree.
+ </para>
+ <para>
+ The Bugzilla Guide is currently only available in English.
+ If you would like to volunteer to translate it, please contact
+ <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
</para>
</section>
@@ -144,13 +119,14 @@
<title>Credits</title>
<para>
The people listed below have made enormous contributions to the
- creation of this Guide, through their dedicated hacking efforts,
+ creation of this Guide, through their writing, dedicated hacking efforts,
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.
+ for the Herculaean task of pulling together the Bugzilla Guide and
+ shepherding it to 2.14.
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
@@ -158,13 +134,13 @@
README upon which the UNIX installation documentation is largely based.
</para>
<para>
- <ulink url="mailto://tara@tequilarista.org">Tara
- Hernandez</ulink> for keeping Bugzilla development going
- strong after Terry left Mozilla.org
+ <ulink url="mailto://tara@tequilarista.org">Tara Hernandez</ulink>
+ for keeping Bugzilla development going
+ strong after Terry left mozilla.org
</para>
<para>
- <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink> for
- providing insight into the key differences between Red Hat's
+ <ulink url="mailto://dkl@redhat.com">Dave Lawrence</ulink>
+ for providing insight into the key differences between Red Hat's
customized Bugzilla, and being largely responsible for the "Red
Hat Bugzilla" appendix
</para>
@@ -174,8 +150,8 @@
questions and arguments on irc.mozilla.org in #mozwebtools
</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.
+ 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>
<para>
Thanks also go to the following people for significant contributions
@@ -183,19 +159,7 @@
</para>
<para>
Zach Liption, Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen,
- Ron Teitelbaum, Jacob Steenhagen, Joe Robins.
- </para>
- </section>
-
- <section id="translations">
- <title>Translations</title>
- <para>
- The Bugzilla Guide needs translators! Please volunteer your
- translation into the language of your choice. If you will
- translate this Guide, please notify the members of the
- mozilla-webtools mailing list at
- <email>mozilla-webtools@mozilla.org</email>, and arrange with
- &bzg-auth; to check it into CVS.
+ Ron Teitelbaum, Jacob Steenhagen, Joe Robins, Gervase Markham.
</para>
</section>