Menu
▾
▴
[phpBT-dev] CVS: phpbt/docs/sgml phpbt.sgml,1.5,1.6 primer.sgml,1.1,1.2
|
From: Benjamin C. <bc...@us...> - 2001-10-03 13:38:10
|
Update of /cvsroot/phpbt/phpbt/docs/sgml
In directory usw-pr-cvs1:/tmp/cvs-serv15278/sgml
Modified Files:
phpbt.sgml primer.sgml
Log Message:
User primer done
Index: phpbt.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/phpbt.sgml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- phpbt.sgml 2001/10/03 04:04:01 1.5
+++ phpbt.sgml 2001/10/03 13:38:06 1.6
@@ -24,6 +24,17 @@
<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">
@@ -32,7 +43,7 @@
<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;
+ &primer;
</chapter>
Index: primer.sgml
===================================================================
RCS file: /cvsroot/phpbt/phpbt/docs/sgml/primer.sgml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- primer.sgml 2001/10/03 04:04:01 1.1
+++ primer.sgml 2001/10/03 13:38:06 1.2
@@ -2,32 +2,51 @@
<sect1 id="primer">
<title>Getting Started</title>
- <sect2>
+ <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>
+
</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>
+
<mediaobject>
<imageobject>
- <imagedata fileref="images/shots/user/enterbug-chooseproject.png" format="PNG" align="center">
+ <imagedata fileref="images/shots/user/enterbug-chooseproject.png" format="PNG" align="center">
</imageobject>
<imageobject>
- <imagedata fileref="images/shots/user/enterbug-chooseproject.jpg" format="JPG" align="center">
+ <imagedata fileref="images/shots/user/enterbug-chooseproject.jpg" format="JPG" align="center">
</imageobject>
<imageobject>
- <imagedata fileref="images/shots/user/enterbug-chooseproject.eps" format="EPS" align="center">
+ <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>
+ <phrase>Screen shot of selecting a project for a bug report.</phrase>
</textobject>
</mediaobject>
- <para>..</para>
+ <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>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/shots/user/enterbug-detail.png" format="PNG" align="center">
+ </imageobject>
+ <imageobject>
+ <imagedata fileref="images/shots/user/enterbug-detail.jpg" format="JPG" align="center">
+ </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>
+ </mediaobject>
+
+ <para>That's it! The bug has been entered, and it's ready to be reviewed and fixed by the developers.</para>
</sect2>
</sect1>
@@ -36,3 +55,9 @@
<!-- sgml-indent-data: 2 -->
<!-- sgml-parent-document: "phpbt.sgml" -->
<!-- End: -->
+
+
+
+
+
+
|
