Menu
▾
▴
[phpBT-dev] CVS: phpbt/docs/sgml bugsearch.sgml,NONE,1.1 phpbt.sgml,1.6,1.7 primer.sgml,1.5,1.6
|
From: Benjamin C. <bc...@us...> - 2001-10-17 04:02:31
|
Update of /cvsroot/phpbt/phpbt/docs/sgml In directory usw-pr-cvs1:/tmp/cvs-serv17839/sgml Modified Files: phpbt.sgml primer.sgml Added Files: bugsearch.sgml Log Message: Added the bug search page and did a little cleanup --- NEW FILE: bugsearch.sgml --- <!-- -*- sgml -*- --> <sect1 id="bugsearch"> <title>Searching the Bug Database</title> <para>The query page presents a wide array of options for finding a specific set of bugs, and thus can be a little overwhelming at first sight. By submitting the default form, without selecting any options, a list of all the bugs in the database will be returned. Every option selected will filter out more bugs as you get more specific in your search.</para> <screenshot> <screeninfo>Bug Search</screeninfo> <mediaobject> <imageobject> <imagedata fileref="images/shots/user/query.png" format="PNG"> </imageobject> <imageobject> <imagedata fileref="images/shots/user/query.jpg" format="JPG"> </imageobject> <imageobject> <imagedata fileref="images/shots/user/query.eps" format="EPS" align="center"> </imageobject> <textobject> <phrase>Screen shot of searching for bugs.</phrase> </textobject> <caption> <para>Searching for bugs.</para> </caption> </mediaobject> </screenshot> <para>The five select boxes at the top allow you to choose bugs with specific characteristics, such as the priority, or those that have reached certain stages in the testing process, such as those that have been fixed. Multiple items can be chosen from each select box, and all options are combined for the filter. For example, if you selected <guilabel>New</guilabel> and <guilabel>Unconfirmed</guilabel>from the <guilabel>Status</guilabel> box and <guilabel>Feature Request</guilabel> from the <guilabel>Severity box</guilabel>, submitting the form would return a list of all the bugs that were designated feature requests and that haven't been handled yet. </para> <para>The middle set of boxes allow you to get more detailed in your search, whether you want to search for bugs assigned to an individual or search for a certain snippet of text in a bug description. The three select boxes immediately following allow you to restrict your search to bugs filed against a certain project, or even against a specific version or component of a project. The last two select boxes determine how the bug list will be sorted.</para> <para>A set of search parameters can be saved and given a name to make it easier to repeat a query in the future. Clicking on a named saved query will take you to the list of bugs that meet the search criteria, and deleting one will remove the link from the list.</para> <para>Finally, at the bottom of every page you will notice four numbers that are linked. These will run a query of open and closed bugs assigned to you, and open and closed bugs reported by you respectively. These links allow you to quickly list which bugs are on your hit list, for example, and to see at a glance the status of bugs assigned to or reported by you.</para> </sect1> <!-- Local Variables: --> <!-- sgml-parent-document: "phpbt.sgml" --> <!-- End: --> Index: phpbt.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/phpbt.sgml,v retrieving revision 1.6 retrieving revision 1.7 diff -u -r1.6 -r1.7 --- phpbt.sgml 2001/10/03 13:38:06 1.6 +++ phpbt.sgml 2001/10/17 04:02:28 1.7 @@ -7,6 +7,7 @@ <!-- User's Guide --> <!ENTITY primer SYSTEM "primer.sgml"> +<!ENTITY bugsearch SYSTEM "bugsearch.sgml"> <!-- Administrator's Guide --> <!ENTITY installation SYSTEM "installation.sgml"> @@ -19,60 +20,48 @@ <book id="index"> - <bookinfo> - <title>&phpbt;</title> - <abstract> - <para>&phpbt; is a web-based bug reporting and tracking system. It helps development teams to manage the testing and debugging segments of the development cycle.</para> - </abstract> - <!--<mediaobject> - <imageobject> - <imagedata fileref="images/logo.jpg" format="JPG" align="left"> - </imageobject> - <imageobject> - <imagedata fileref="images/logo.eps" format="EPS" align="left"> - </imageobject> - <textobject> - <phrase>&phpbt; logo</phrase> - </textobject> - </mediaobject>--> - </bookinfo> - - <chapter id="userguide"> - <title>User's Guide</title> - <abstract> - <para>Currently all interactions with &phpbt; are done via the web interface. Users can submit bugs, communicate with developers and testers about bugs, and search through the bug database.</para> - </abstract> - - &primer; - - </chapter> - - <chapter id="adminguide"> - <title>Administrator's Guide</title> - <abstract> - <para>One of the main design goals of &phpbt; is to make installation and administration easy. In fact, the difficulty of installing bugzilla was a key motivator for &phpbt;'s existence.</para> - </abstract> - - &installation; - &configuration; - - </chapter> - - <chapter id="devguide"> - <title>Developer's Guide</title> - <abstract> - <para>Adding on to or extending &phpbt; should be easy for those with a knowledge of PHP and SQL. New developers are always welcome to join the project at <ulink url="http://www.sourceforge.net/projects/phpbt/">http://www.sourceforge.net/projects/phpbt</ulink>, or to simply submit patches, bug reports, or feature requests.</para> - </abstract> +<bookinfo> +<title>&phpbt;</title> +<abstract> +<para>&phpbt; is a web-based bug reporting and tracking system. It helps development teams to manage the testing and debugging segments of the development cycle.</para> +</abstract> +</bookinfo> + +<chapter id="userguide"> +<title>User's Guide</title> +<abstract> +<para>Currently all interactions with &phpbt; are done via the web interface. Users can submit bugs, communicate with developers and testers about bugs, and search through the bug database.</para> +</abstract> + +&primer; +&bugsearch; + +</chapter> + +<chapter id="adminguide"> +<title>Administrator's Guide</title> +<abstract> +<para>One of the main design goals of &phpbt; is to make installation and administration easy. In fact, the difficulty of installing bugzilla was a key motivator for &phpbt;'s existence.</para> +</abstract> + +&installation; +&configuration; + +</chapter> + +<chapter id="devguide"> +<title>Developer's Guide</title> +<abstract> +<para>Adding on to or extending &phpbt; should be easy for those with a knowledge of PHP and SQL. New developers are always welcome to join the project at <ulink url="http://www.sourceforge.net/projects/phpbt/">http://www.sourceforge.net/projects/phpbt</ulink>, or to simply submit patches, bug reports, or feature requests.</para> +</abstract> - &dependencies; - &devstandards; +&dependencies; +&devstandards; - </chapter> +</chapter> </book> <!-- Local Variables: --> -<!-- sgml-indent-step: 2 --> -<!-- sgml-indent-data: 2 --> <!-- End: --> Index: primer.sgml =================================================================== RCS file: /cvsroot/phpbt/phpbt/docs/sgml/primer.sgml,v retrieving revision 1.5 retrieving revision 1.6 diff -u -r1.5 -r1.6 --- primer.sgml 2001/10/08 13:57:11 1.5 +++ primer.sgml 2001/10/17 04:02:28 1.6 @@ -1,70 +1,68 @@ <!-- -*- sgml -*- --> <sect1 id="primer"> - <title>Getting Started</title> +<title>Getting Started</title> - <sect2 id="createaccount"> - <title>Creating an account</title> +<sect2 id="createaccount"> +<title>Creating an account</title> - <para>You can create a new account by following the link labeled <emphasis role="bold">Open a new account</emphasis>. To create a new account you will need to enter at least a valid email address (so that your password can be mailed to you). Providing your name is optional, but if you submit it then your name will appear with bugs you submit and comments you make. If the system has been configured to use a login separate from the email address, you will also be prompted for a login. If you have chosen an email address (or login) that is already in use, you will be prompted to choose a different one. After completing this form, your password will be mailed to you. Once you have received your password you can then login with your email (or login) and password to be able to submit bugs.</para> +<para>You can create a new account by following the link labeled <emphasis role="bold">Open a new account</emphasis>. To create a new account you will need to enter at least a valid email address (so that your password can be mailed to you). Providing your name is optional, but if you submit it then your name will appear with bugs you submit and comments you make. If the system has been configured to use a login separate from the email address, you will also be prompted for a login. If you have chosen an email address (or login) that is already in use, you will be prompted to choose a different one. After completing this form, your password will be mailed to you. Once you have received your password you can then login with your email (or login) and password to be able to submit bugs.</para> - </sect2> +</sect2> - <sect2 id="enterbug"> - <title>Entering a bug</title> - - <para>Once you have logged in to the system you can follow the <emphasis role="bold">Enter Bug</emphasis> link from the top navigation bar to create a new bug. If there is more than one project for which you can submit a bug, you will be prompted to choose one.</para> - - <screenshot> - <screeninfo>Project selection</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-chooseproject.png" format="PNG"> - </imageobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-chooseproject.jpg" format="JPG"> - </imageobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-chooseproject.eps" format="EPS" align="center"> - </imageobject> - <textobject> - <phrase>Screen shot of selecting a project for a bug report.</phrase> - </textobject> - <caption> - <para>Selecting a project for a bug report.</para> - </caption> - </mediaobject> - </screenshot> - - <para>Once you have chosen a project, or if there is only one project in the system, you will see the bug entry page. The <emphasis role="bold">Version</emphasis> and <emphasis role="bold">Component</emphasis> fields allow you to specify details about which part or version of the product that produces this bug. The <emphasis role="bold">Summary</emphasis> field should be a short but specific summary of the problem, while the <emphasis role="bold">Description</emphasis> field should include details about the behavior observed, how that behavior differs from expected behavior, and the steps to reproduce the problem. If the product being tested is web-based, you can use the <emphasis role="bold">URL</emphasis> field to provide a link directly to the problem. The <emphasis role="bold">Add another</emphasis> checkbox, if checked, will present another bug entry form when you submit a bug, instead of taking you to the bug list.</para> - - <screenshot> - <screeninfo>Adding a bug</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-detail.png" format="PNG"> - </imageobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-detail.jpg" format="JPG"> - </imageobject> - <imageobject> - <imagedata fileref="images/shots/user/enterbug-detail.eps" format="EPS" align="center"> - </imageobject> - <textobject> - <phrase>Screen shot of entering a bug report.</phrase> - </textobject> - <caption> - <para>Entering a bug report.</para> - </caption> - </mediaobject> - </screenshot> +<sect2 id="enterbug"> +<title>Entering a bug</title> + +<para>Once you have logged in to the system you can follow the <emphasis role="bold">Enter Bug</emphasis> link from the top navigation bar to create a new bug. If there is more than one project for which you can submit a bug, you will be prompted to choose one.</para> + +<screenshot> +<screeninfo>Project selection</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-chooseproject.png" format="PNG"> +</imageobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-chooseproject.jpg" format="JPG"> +</imageobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-chooseproject.eps" format="EPS" align="center"> +</imageobject> +<textobject> +<phrase>Screen shot of selecting a project for a bug report.</phrase> +</textobject> +<caption> +<para>Selecting a project for a bug report.</para> +</caption> +</mediaobject> +</screenshot> + +<para>Once you have chosen a project, or if there is only one project in the system, you will see the bug entry page. The <emphasis role="bold">Version</emphasis> and <emphasis role="bold">Component</emphasis> fields allow you to specify details about which part or version of the product that produces this bug. The <emphasis role="bold">Summary</emphasis> field should be a short but specific summary of the problem, while the <emphasis role="bold">Description</emphasis> field should include details about the behavior observed, how that behavior differs from expected behavior, and the steps to reproduce the problem. If the product being tested is web-based, you can use the <emphasis role="bold">URL</emphasis> field to provide a link directly to the problem. The <emphasis role="bold">Add another</emphasis> checkbox, if checked, will present another bug entry form when you submit a bug, instead of taking you to the bug list.</para> + +<screenshot> +<screeninfo>Adding a bug</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-detail.png" format="PNG"> +</imageobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-detail.jpg" format="JPG"> +</imageobject> +<imageobject> +<imagedata fileref="images/shots/user/enterbug-detail.eps" format="EPS" align="center"> +</imageobject> +<textobject> +<phrase>Screen shot of entering a bug report.</phrase> +</textobject> +<caption> +<para>Entering a bug report.</para> +</caption> +</mediaobject> +</screenshot> - <para>That's it! The bug has been entered, and it's ready to be reviewed and fixed by the developers.</para> - </sect2> +<para>That's it! The bug has been entered, and it's ready to be reviewed and fixed by the developers.</para> +</sect2> </sect1> <!-- Local Variables: --> -<!-- sgml-indent-step: 2 --> -<!-- sgml-indent-data: 2 --> <!-- sgml-parent-document: "phpbt.sgml" --> <!-- End: --> |
