diff options
Diffstat (limited to 'docs/en/rst')
| -rw-r--r-- | docs/en/rst/about.rst | 8 | ||||
| -rw-r--r-- | docs/en/rst/administration.rst | 8 | ||||
| -rw-r--r-- | docs/en/rst/glossary.rst | 328 | ||||
| -rw-r--r-- | docs/en/rst/installation.rst | 18 | ||||
| -rw-r--r-- | docs/en/rst/security.rst | 4 |
5 files changed, 17 insertions, 349 deletions
diff --git a/docs/en/rst/about.rst b/docs/en/rst/about.rst index 199988bf4..2f100a325 100644 --- a/docs/en/rst/about.rst +++ b/docs/en/rst/about.rst @@ -148,14 +148,10 @@ Document Conventions This document uses the following conventions: -.. caution:: This is a caution. Make sure to read this to not be in trouble! - -.. tip:: This is a hint or tip, especially about some configuration tweaks. +.. warning:: This is a warning - something you should be aware of. .. note:: This is just a note, for your information. -.. warning:: This is a warning, something you should take care of. - A filename or a path to a filename is displayed like this: :file:`/path/to/filename.ext` @@ -177,7 +173,7 @@ A sample of code is illustrated like this: Second Line of Code ... -This documentation is maintained in ReStructured Text format. +This documentation is maintained in reStructured Text format. Changes are best submitted as diffs, attached to a bug filed in the `Bugzilla Documentation <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla;component=Documentation>`_ component. diff --git a/docs/en/rst/administration.rst b/docs/en/rst/administration.rst index 2bac84499..81dc35107 100644 --- a/docs/en/rst/administration.rst +++ b/docs/en/rst/administration.rst @@ -327,7 +327,7 @@ authentication, all other user-related tasks are still handled by email address, not LDAP username. For example, bugs are still assigned by email address and users are still queried by email address. -.. caution:: Because the Bugzilla account is not created until the first time +.. warning:: Because the Bugzilla account is not created until the first time a user logs in, a user who has not yet logged is unknown to Bugzilla. This means they cannot be used as an assignee or QA contact (default or otherwise), added to any CC list, or any other such operation. One @@ -360,7 +360,7 @@ LDAPserver the URI, the default is either 389 or 636 for 'LDAP' and 'LDAPS' schemes respectively. - .. tip:: In order to use SSL with LDAP, specify a URI with "ldaps://". + .. note:: In order to use SSL with LDAP, specify a URI with "ldaps://". This will force the use of SSL over port 636. For example, normal LDAP: ``ldap://ldap.company.com``, LDAP over SSL: @@ -577,7 +577,7 @@ password for this "super user". If for some reason you delete the "super user" account, re-running checksetup.pl will again prompt you for this username and password. -.. tip:: If you wish to add more administrative users, add them to +.. note:: If you wish to add more administrative users, add them to the "admin" group and, optionally, edit the tweakparams, editusers, creategroups, editcomponents, and editkeywords groups to add the entire admin group to those groups (which is the case by default). @@ -1645,7 +1645,7 @@ adding too many fields can make the user interface more complicated and harder to use. Custom Fields should be added only when necessary and with careful consideration. -.. tip:: Before adding a Custom Field, make sure that Bugzilla cannot already +.. note:: Before adding a Custom Field, make sure that Bugzilla cannot already do the desired behavior. Many Bugzilla options are not enabled by default, and many times Administrators find that simply enabling certain options that already exist is sufficient. diff --git a/docs/en/rst/glossary.rst b/docs/en/rst/glossary.rst deleted file mode 100644 index 83bb951bb..000000000 --- a/docs/en/rst/glossary.rst +++ /dev/null @@ -1,328 +0,0 @@ - - -.. _glossary: - -======== -Glossary -======== - -0-9, high ascii -############### - -.htaccess - Apache web server, and other NCSA-compliant web servers, - observe the convention of using files in directories called - :file:`.htaccess` - to restrict access to certain files. In Bugzilla, they are used - to keep secret files which would otherwise - compromise your installation - e.g. the - :file:`localconfig` - file contains the password to your database. - curious. - -.. _gloss-a: - -A -# - -Apache - In this context, Apache is the web server most commonly used - for serving up Bugzilla - pages. Contrary to popular belief, the apache web server has nothing - to do with the ancient and noble Native American tribe, but instead - derived its name from the fact that it was - ``a patchy`` - version of the original - NCSA - world-wide-web server. - - Useful Directives when configuring Bugzilla - - `AddHandler <http://httpd.apache.org/docs/2.0/mod/mod_mime.html#addhandler>`_ - Tell Apache that it's OK to run CGI scripts. - - `AllowOverride <http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride>`_, `Options <http://httpd.apache.org/docs-2.0/mod/core.html#options>`_ - These directives are used to tell Apache many things about - the directory they apply to. For Bugzilla's purposes, we need - them to allow script execution and :file:`.htaccess` - overrides. - - `DirectoryIndex <http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex>`_ - Used to tell Apache what files are indexes. If you can - not add :file:`index.cgi` to the list of valid files, - you'll need to set ``$index_html`` to - 1 in :file:`localconfig` so - :command:`./checksetup.pl` will create an - :file:`index.html` that redirects to - :file:`index.cgi`. - - `ScriptInterpreterSource <http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource>`_ - Used when running Apache on windows so the shebang line - doesn't have to be changed in every Bugzilla script. - - For more information about how to configure Apache for Bugzilla, - see :ref:`http-apache`. - -.. _gloss-b: - -B -# - -Bug - A - ``bug`` - in Bugzilla refers to an issue entered into the database which has an - associated number, assignments, comments, etc. Some also refer to a - ``tickets`` - or - ``issues``; - in the context of Bugzilla, they are synonymous. - -Bug Number - Each Bugzilla bug is assigned a number that uniquely identifies - that bug. The bug associated with a bug number can be pulled up via a - query, or easily from the very front page by typing the number in the - "Find" box. - -Bugzilla - Bugzilla is the world-leading free software bug tracking system. - -.. _gloss-c: - -C -# - -Common Gateway Interface (CGI) - CGI is an acronym for Common Gateway Interface. This is - a standard for interfacing an external application with a web server. Bugzilla - is an example of a CGI application. - -Component - A Component is a subsection of a Product. It should be a narrow - category, tailored to your organization. All Products must contain at - least one Component (and, as a matter of fact, creating a Product - with no Components will create an error in Bugzilla). - -Comprehensive Perl Archive Network (CPAN) - CPAN - stands for the - ``Comprehensive Perl Archive Network``. - CPAN maintains a large number of extremely useful - Perl - modules - encapsulated chunks of code for performing a - particular task. - - The :file:`contrib` directory is - a location to put scripts that have been contributed to Bugzilla but - are not a part of the official distribution. These scripts are written - by third parties and may be in languages other than perl. For those - that are in perl, there may be additional modules or other requirements - than those of the official distribution. - - .. note:: Scripts in the :file:`contrib` - directory are not officially supported by the Bugzilla team and may - break in between versions. - -.. _gloss-d: - -D -# - -daemon - A daemon is a computer program which runs in the background. In - general, most daemons are started at boot time via System V init - scripts, or through RC scripts on BSD-based systems. - mysqld, - the MySQL server, and - apache, - a web server, are generally run as daemons. - -DOS Attack - A DOS, or Denial of Service attack, is when a user attempts to - deny access to a web server by repeatedly accessing a page or sending - malformed requests to a webserver. A D-DOS, or - Distributed Denial of Service attack, is when these requests come - from multiple sources at the same time. Unfortunately, these are much - more difficult to defend against. - -.. _gloss-g: - -G -# - -Groups - The word - ``Groups`` - has a very special meaning to Bugzilla. Bugzilla's main security - mechanism comes by placing users in groups, and assigning those - groups certain privileges to view bugs in particular - Products - in the - Bugzilla - database. - -.. _gloss-j: - -J -# - -JavaScript - JavaScript is cool, we should talk about it. - -.. _gloss-m: - -M -# - -Message Transport Agent (MTA) - A Message Transport Agent is used to control the flow of email on a system. - The `Email::Send <http://search.cpan.org/dist/Email-Send/lib/Email/Send.pm>`_ - Perl module, which Bugzilla uses to send email, can be configured to - use many different underlying implementations for actually sending the - mail using the ``mail_delivery_method`` parameter. - -MySQL - MySQL is one of the supported - RDBMS for Bugzilla. MySQL - can be downloaded from `<http://www.mysql.com>`_. While you - should familiarize yourself with all of the documentation, some high - points are: - - `Backup <http://www.mysql.com/doc/en/Backup.html>`_ - Methods for backing up your Bugzilla database. - `Option Files <http://www.mysql.com/doc/en/Option_files.html>`_ - Information about how to configure MySQL using - :file:`my.cnf`. - `Privilege System <http://www.mysql.com/doc/en/Privilege_system.html>`_ - Information about how to protect your MySQL server. - -.. _gloss-p: - -P -# - -Perl Package Manager (PPM) - `<http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/>`_ - -Product - A Product is a broad category of types of bugs, normally - representing a single piece of software or entity. In general, - there are several Components to a Product. A Product may define a - group (used for security) for all bugs entered into - its Components. - -Perl - First written by Larry Wall, Perl is a remarkable program - language. It has the benefits of the flexibility of an interpreted - scripting language (such as shell script), combined with the speed - and power of a compiled language, such as C. - Bugzilla - is maintained in Perl. - -.. _gloss-q: - -Q -# - -QA - ``QA``, - ``Q/A``, and - ``Q.A.`` - are short for - ``Quality Assurance``. - In most large software development organizations, there is a team - devoted to ensuring the product meets minimum standards before - shipping. This team will also generally want to track the progress of - bugs over their life cycle, thus the need for the - ``QA Contact`` - field in a bug. - -.. _gloss-r: - -R -# - -Relational DataBase Management System (RDBMS) - A relational database management system is a database system - that stores information in tables that are related to each other. - -Regular Expression (regexp) - A regular expression is an expression used for pattern matching. - `Documentation <http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions>`_ - -.. _gloss-s: - -S -# - -Service - In Windows NT environment, a boot-time background application - is referred to as a service. These are generally managed through the - control panel while logged in as an account with - ``Administrator`` level capabilities. For more - information, consult your Windows manual or the MSKB. - - SGML - stands for - ``Standard Generalized Markup Language``. - Created in the 1980's to provide an extensible means to maintain - documentation based upon content instead of presentation, - SGML - has withstood the test of time as a robust, powerful language. - XML - is the - ``baby brother`` - of SGML; any valid - XML - document it, by definition, a valid - SGML - document. The document you are reading is written and maintained in - SGML, - and is also valid - XML - if you modify the Document Type Definition. - -.. _gloss-t: - -T -# - -Target Milestone - Target Milestones are Product goals. They are configurable on a - per-Product basis. Most software development houses have a concept of - ``milestones`` - where the people funding a project expect certain functionality on - certain dates. Bugzilla facilitates meeting these milestones by - giving you the ability to declare by which milestone a bug will be - fixed, or an enhancement will be implemented. - -Tool Command Language (TCL) - TCL is an open source scripting language available for Windows, - Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but - never released. The first release of Bugzilla was 2.0, which was when - it was ported to perl. - -.. _gloss-z: - -Z -# - -Zarro Boogs Found - This is just a goofy way of saying that there were no bugs - found matching your query. When asked to explain this message, - Terry had the following to say: - - *Terry Weissman*: - I've been asked to explain this ... way back when, when - Netscape released version 4.0 of its browser, we had a release - party. Naturally, there had been a big push to try and fix every - known bug before the release. Naturally, that hadn't actually - happened. (This is not unique to Netscape or to 4.0; the same thing - has happened with every software project I've ever seen.) Anyway, - at the release party, T-shirts were handed out that said something - like "Netscape 4.0: Zarro Boogs". Just like the software, the - T-shirt had no known bugs. Uh-huh. - So, when you query for a list of bugs, and it gets no results, - you can think of this as a friendly reminder. Of \*course* there are - bugs matching your query, they just aren't in the bugsystem yet... - diff --git a/docs/en/rst/installation.rst b/docs/en/rst/installation.rst index 9d92c0971..d9a8488f5 100644 --- a/docs/en/rst/installation.rst +++ b/docs/en/rst/installation.rst @@ -176,7 +176,7 @@ Good locations are either directly in the web server's document directories or in :file:`/usr/local` with a symbolic link to the web server's document directories or an alias in the web server's configuration. -.. caution:: The default Bugzilla distribution is NOT designed to be placed +.. warning:: The default Bugzilla distribution is NOT designed to be placed in a :file:`cgi-bin` directory. This includes any directory which is configured using the ``ScriptAlias`` directive of Apache. @@ -228,7 +228,7 @@ you invoke :file:`install-module.pl` as follows: bash# perl install-module.pl <modulename> -.. tip:: Many people complain that Perl modules will not install for +.. note:: Many people complain that Perl modules will not install for them. Most times, the error messages complain that they are missing a file in ``@INC``. @@ -435,7 +435,7 @@ hosting account), you will need to leave that :file:`checksetup.pl` will subsequently display every time it is run. -.. caution:: If you are using suexec, you should use your own primary group +.. warning:: If you are using suexec, you should use your own primary group for *webservergroup* rather than leaving it empty, and see the additional directions in the suexec section :ref:`suexec`. @@ -471,7 +471,7 @@ see what has changed. MySQL ----- -.. caution:: MySQL's default configuration is insecure. +.. warning:: MySQL's default configuration is insecure. We highly recommend to run :file:`mysql_secure_installation` on Linux or the MySQL installer on Windows, and follow the instructions. Important points to note are: @@ -706,7 +706,7 @@ When this is done, restart your web server. SQLite ------ -.. caution:: Due to SQLite's `concurrency +.. warning:: Due to SQLite's `concurrency limitations <http://sqlite.org/faq.html#q5>`_ we recommend SQLite only for small and development Bugzilla installations. @@ -1214,7 +1214,7 @@ the ActiveState repository. provided when you run :command:`checksetup.pl` as it will tell you what package you'll need to install. -.. tip:: If you are behind a corporate firewall, you will need to let the +.. note:: If you are behind a corporate firewall, you will need to let the ActiveState PPM utility know how to get through it to access the repositories by setting the HTTP_proxy system environmental variable. For more information on setting that variable, see @@ -1712,7 +1712,7 @@ using Bzr. ... All changes applied successfully. -.. caution:: If a line in the output from :command:`bzr up` mentions +.. warning:: If a line in the output from :command:`bzr up` mentions a conflict, then that represents a file with local changes that Bzr was unable to properly merge. You need to resolve these conflicts manually before Bugzilla (or at least the portion using @@ -1754,7 +1754,7 @@ omit the first three lines of the example. is a very important detail--it means that the destination directory is the current working directory. -.. caution:: If you have some extensions installed, you will have to copy them +.. warning:: If you have some extensions installed, you will have to copy them to the new bugzilla directory too. Extensions are located in :file:`bugzilla/extensions/`. Only copy those you installed, not those managed by the Bugzilla team. @@ -1831,7 +1831,7 @@ steps to complete your upgrade. command :command:`./checksetup.pl` is important and cannot be omitted. - .. caution:: If this is a major upgrade (say, 3.6 to 4.2 or similar), + .. warning:: If this is a major upgrade (say, 3.6 to 4.2 or similar), running :command:`checksetup.pl` on a large installation (75,000 or more bugs) can take a long time, possibly several hours. diff --git a/docs/en/rst/security.rst b/docs/en/rst/security.rst index 4813ffe76..17dfc73a2 100644 --- a/docs/en/rst/security.rst +++ b/docs/en/rst/security.rst @@ -93,7 +93,7 @@ be accessible is rather complicated. A quick way is to run Bugzilla files as expected. If not, you may want to follow the few steps below. -.. tip:: Bugzilla ships with the ability to create :file:`.htaccess` +.. note:: Bugzilla ships with the ability to create :file:`.htaccess` files that enforce these rules. Instructions for enabling these directives in Apache can be found in :ref:`http-apache` @@ -134,7 +134,7 @@ or `Bugtraq ID 6501 <http://online.securityfocus.com/bid/6501>`_. To test, simply run :file:`testserver.pl`, as said above. -.. tip:: Be sure to check :ref:`http` for instructions +.. note:: Be sure to check :ref:`http` for instructions specific to the web server you use. .. _security-bugzilla: |