glenn       02/04/10 18:31:49

  Added:       docs     bugreport.html
               xdocs    bugreport.xml
  Log:
  Create a bug report document to point to instead of bugzilla
  
  Revision  Changes    Path
  1.1                  jakarta-tomcat-site/docs/bugreport.html
  
  Index: bugreport.html
  ===================================================================
  <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" 
"http://www.w3.org/TR/html4/loose.dtd";>
  
  <!-- Content Stylesheet for Site -->
  
          
  <!-- start the processing -->
      <!-- ====================================================================== -->
      <!-- Main Page Section -->
      <!-- ====================================================================== -->
      <html>
          <head>
              <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
  
                                                      <meta name="author" value="Glenn 
L. Nielsen">
              <meta name="email" value="$au.getAttributeValue("email")">
              
             
                                      
              <title>The Jakarta Site - Report a Tomcat Bug</title>
          </head>
  
          <body bgcolor="#ffffff" text="#000000" link="#525D76">        
              <table border="0" width="100%" cellspacing="0">
                  <!-- TOP IMAGE -->
                  <tr>
                      <td align="left">
  <a href="http://jakarta.apache.org";><img 
src="http://jakarta.apache.org/images/jakarta-logo.gif"; border="0"/></a>
  </td>
  <td align="right">
  <a href="http://jakarta.apache.org/tomcat";><img src="./images/tomcat.gif" alt="The 
Apache Tomcat Project" border="0"/></a>
  </td>
                  </tr>
              </table>
              <table border="0" width="100%" cellspacing="4">
                  <tr><td colspan="2">
                      <hr noshade="" size="1"/>
                  </td></tr>
                  
                  <tr>
                      <!-- LEFT SIDE NAVIGATION -->
                      <td width="20%" valign="top" nowrap="true">
                                  <p><strong>Tomcat</strong></p>
          <ul>
                      <li>    <a href="./index.html">Front Page</a>
  </li>
                      <li>    <a href="./news.html">News & Status</a>
  </li>
                      <li>    <a href="./resources.html">Resources</a>
  </li>
                  </ul>
              <p><strong>Documentation</strong></p>
          <ul>
                      <li>    <a href="./tomcat-3.2-doc/index.html">Tomcat 3.2</a>
  </li>
                      <li>    <a href="./tomcat-3.3-doc/index.html">Tomcat 3.3</a>
  </li>
                      <li>    <a href="./tomcat-4.0-doc/index.html">Tomcat 4.0</a>
  </li>
                      <li>    <a href="./tomcat-4.1-doc/index.html">Tomcat 4.next</a>
  </li>
                  </ul>
              <p><strong>Download</strong></p>
          <ul>
                      <li>    <a 
href="http://jakarta.apache.org/site/binindex.html";>Binaries</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/sourceindex.html";>Source Code</a>
  </li>
                  </ul>
              <p><strong>Jakarta</strong></p>
          <ul>
                      <li>    <a href="./index.html">Front Page</a>
  </li>
                      <li>    <a href="http://jakarta.apache.org/site/news.html";>News 
& Status</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/mission.html";>Mission</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/guidelines.html";>Guidelines Notes</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/faqs.html";>FAQs</a>
  </li>
                  </ul>
              <p><strong>Get Involved</strong></p>
          <ul>
                      <li>    <a 
href="http://jakarta.apache.org/site/getinvolved.html";>Overview</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/cvsindex.html";>CVS Repositories</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a>
  </li>
                      <li>    <a href="./irc.html">IRC</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/library.html";>Reference Library</a>
  </li>
                      <li>    <a href="http://jakarta.apache.org/site/bugs.html";>Bug 
Database</a>
  </li>
                  </ul>
              <p><strong>Misc</strong></p>
          <ul>
                      <li>    <a 
href="http://jakarta.apache.org/site/whoweare.html";>Who We Are</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/acknowledgements.html";>Acknowledgements</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/contact.html";>Contact</a>
  </li>
                      <li>    <a 
href="http://jakarta.apache.org/site/legal.html";>Legal</a>
  </li>
                  </ul>
                          </td>
                      <td width="80%" align="left" valign="top">
                                                                      <table 
border="0" cellspacing="0" cellpadding="2" width="100%">
        <tr><td bgcolor="#525D76">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Before you report a bug"><strong>Before you report a 
bug</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>The Tomcat community consists of those who 
use Tomcat, help answer
  questions on discussions lists, contribute documentation and patches,
  and those who develop and maintain the code for Tomcat.  Almost all those
  who assist on a day to day basis resolving bug reports do this for a
  wide variety of reasons, and almost all of them do this on their own time.</p>
                                                  <p>Many bugs reported end up not 
being a bug in the Tomcat code, but are
  due to misconfiguration, problems caused by installed applications, the
  operating system, etc.
  <ul>
  <b>Before reporting a bug please make every effort to resolve the problem
  yourself.</b>
  </ul>
  The remainder of this document points you toward resources you can use to
  resolve the problem you are having.
  </p>
                              </blockquote>
          </p>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                                  <table border="0" cellspacing="0" 
cellpadding="2" width="100%">
        <tr><td bgcolor="#525D76">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Resources to help resolve Tomcat problems"><strong>Resources to 
help resolve Tomcat problems</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>Here are some resources you can use to help 
you resolve the
  problem you are having before reporting a bug.</p>
                                                      <table border="0" 
cellspacing="0" cellpadding="2" width="100%">
        <tr><td bgcolor="#828DA6">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Problem trouble shooting"><strong>Problem trouble 
shooting</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>
      <li><b>Documentation</b> - Review the documentation for the version
        of Tomcat you are using.  The problem you are having may already
        be addressed in the docs.</li>
      <li><b>Logs</b> - The logs which Tomcat generates can be a valuable
        resource when trying to diagnose a problem.  Please review them.
        You may want to enable debug output in your Tomcat configuration
        so that you have more information to help diagnose the problem.</li>
      <li><b>FAQ's</b> - Search Frequently Asked Question documents. FAQ's
        for all Jakarta projects can be found
        <a href="http://jakarta.apache.org/site/faqs.html";>here</a>.</li>
      </p>
                              </blockquote>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                                      <table border="0" 
cellspacing="0" cellpadding="2" width="100%">
        <tr><td bgcolor="#828DA6">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Bug Database"><strong>Bug Database</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>Please search the bug database to see if the 
bug you are
        seeing has already been reported.
        <ul> 
          <li>The bug may have already been fixed and is available in a later
          version or nightly build.</li>
          <li>Someone else may have reported the bug, you could add supporting
          information to help reproduce and resolve the bug.</li>
        </ul>
        Search the Tomcat 3 bug database
        <a href="http://nagoya.apache.org/bugzilla/query.cgi?product=Tomcat%203";>
        here</a>.<br />
        Search the Tomcat 4 bug database
        <a href="http://nagoya.apache.org/bugzilla/query.cgi?product=Tomcat%204";>
        here</a>.<br />
      </p>
                              </blockquote>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                                      <table border="0" 
cellspacing="0" cellpadding="2" width="100%">
        <tr><td bgcolor="#828DA6">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Tomcat discussion lists"><strong>Tomcat discussion 
lists</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>It is very likely you are not the first to 
run into a problem.
        Others may have already found a solution.  The <b>tomcat-user</b>
        or <b>tomcat-dev</b> list archives may contain discussions which
        will help you resolve the problem. Search the Tomcat User List archive
        <a href="http://www.mail-archive.com/tomcat-user@jakarta.apache.org/";>here</a>
        or <a href="http://mikal.org/interests/java/tomcat/index.html";>here</a>
        and the Tomcat Developer List archive
        <a href="http://www.mail-archive.com/tomcat-dev@jakarta.apache.org/";>here</a>
        or <a href="http://www.metronet.com/~wjm/tomcat/";>here</a>.
      </p>
                                                  <p>If you have already subscribed to 
the
        <a href="mailto:[EMAIL PROTECTED]";>tomcat-user</a>
        or <a href="mailto:[EMAIL PROTECTED]";>tomcat-dev</a>
        discussion lists you can ask about the problem on those lists.
        If you are not subscribed, you can learn about the lists and subscribe
        <a herf="http://jakarta.apache.org/site/mail.html";>here</a>.
      </p>
                              </blockquote>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                                      <table border="0" 
cellspacing="0" cellpadding="2" width="100%">
        <tr><td bgcolor="#828DA6">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Tomcat on IRC"><strong>Tomcat on IRC</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>An IRC channel dedicated to Tomcat exists on 
OpenProjects.</p>
                                                  <p><code>#tomcat</code> at 
<code>irc.us.openprojects.net</code>.
      Click <a href="irc://irc.us.openprojects.net/tomcat">here</a> to
      connect to the channel using Mozilla.</p>
                              </blockquote>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                              </blockquote>
          </p>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                                  <table border="0" cellspacing="0" 
cellpadding="2" width="100%">
        <tr><td bgcolor="#525D76">
          <font color="#ffffff" face="arial,helvetica,sanserif">
            <a name="Reporting a Tomcat bug"><strong>Reporting a Tomcat 
bug</strong></a>
          </font>
        </td></tr>
        <tr><td>
          <blockquote>
                                      <p>If after you have exhausted all other 
resources to resolve a problem
  with Tomcat you may want to file a bug report.  Please make sure the
  problem is a bug in Tomcat and not a bug in your web application.</p>
                                                  <p>Please make sure you provide as 
much information as possible. Its
  very hard to fix a bug if the person looking into the problem can't
  reproduce it.  Here is a listing of information which should be included:
  <ul>
    <li><b>Version</b> - Tomcat version, if from a nightly build, version
      and date of build.</li>
    <li><b>Tomcat component</b> - Tomcat component which has the bug.</li>
    <li><b>Platform</b> - Hardward platform Tomcat is running on.</li>
    <li><b>OS</b> - Computer operating system and version.</li>
    <li><b>JVM</b> - JVM Version</li>
    <li><b>Web Server</b> - Web Server and version, Tomcat Connector and version.</li>
    <li><b>Configuration</b> - Attach configuration files if they would help track
      down the bug.</li>
    <li><b>Log file excerpts</b> - Review your logs files, reproduce the bug with
      debugging enabled in your Tomcat configuration.  Then submit any relevant
      sections of the log which help document the bug.</li>
    <li><b>Stack Traces</b> - Any stack traces generated by the bug.</li>
    <li><b>Example</b> - Example configuration files or web applications which
      demonstrate the bug.  When submitting an example which reproduces the bug,
      please try to make it as simple as possible.</li>
    <li><b>Bug Fix Patch</b> - A patch created using diff -u which fixes the bug.
      (If you have found a bug fixwhich can be applied to the Tomcat code)</li>
    <li><b>Miscellaneous</b> - Any other information you feel will help track
      down the problem.  For example other Java API's and versions being used
      with Tomcat.</li>
  </ul>
  
  Report a Tomcat 4 bug
  <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%204";>
  here</a>.<br />
  Report a Tomcat 3 bug
  <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%203";>
  here</a>.<br />
  </p>
                              </blockquote>
          </p>
        </td></tr>
        <tr><td><br/></td></tr>
      </table>
                                          </td>
                  </tr>
  
                  <!-- FOOTER -->
                  <tr><td colspan="2">
                      <hr noshade="" size="1"/>
                  </td></tr>
                  <tr><td colspan="2">
                      <div align="center"><font color="#525D76" size="-1"><em>
                      Copyright &#169; 1999-2002, Apache Software Foundation
                      </em></font></div>
                  </td></tr>
              </table>
          </body>
      </html>
  <!-- end the processing -->
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  1.1                  jakarta-tomcat-site/xdocs/bugreport.xml
  
  Index: bugreport.xml
  ===================================================================
  <?xml version="1.0"?>
  <document>
  
    <properties>
      <author>Glenn L. Nielsen</author>
      <title>Report a Tomcat Bug</title>
    </properties>
  
  <body>
  
  <section name="Before you report a bug">
  <p>The Tomcat community consists of those who use Tomcat, help answer
  questions on discussions lists, contribute documentation and patches,
  and those who develop and maintain the code for Tomcat.  Almost all those
  who assist on a day to day basis resolving bug reports do this for a
  wide variety of reasons, and almost all of them do this on their own time.</p>
  
  <p>Many bugs reported end up not being a bug in the Tomcat code, but are
  due to misconfiguration, problems caused by installed applications, the
  operating system, etc.
  <ul>
  <b>Before reporting a bug please make every effort to resolve the problem
  yourself.</b>
  </ul>
  The remainder of this document points you toward resources you can use to
  resolve the problem you are having.
  </p>
  </section>
  
  <section name="Resources to help resolve Tomcat problems">
  <p>Here are some resources you can use to help you resolve the
  problem you are having before reporting a bug.</p>
  
    <subsection name="Problem trouble shooting">
      <p>
      <li><b>Documentation</b> - Review the documentation for the version
        of Tomcat you are using.  The problem you are having may already
        be addressed in the docs.</li>
      <li><b>Logs</b> - The logs which Tomcat generates can be a valuable
        resource when trying to diagnose a problem.  Please review them.
        You may want to enable debug output in your Tomcat configuration
        so that you have more information to help diagnose the problem.</li>
      <li><b>FAQ's</b> - Search Frequently Asked Question documents. FAQ's
        for all Jakarta projects can be found
        <a href="http://jakarta.apache.org/site/faqs.html";>here</a>.</li>
      </p>
    </subsection>
  
    <subsection name="Bug Database">
      <p>Please search the bug database to see if the bug you are
        seeing has already been reported.
        <ul> 
          <li>The bug may have already been fixed and is available in a later
          version or nightly build.</li>
          <li>Someone else may have reported the bug, you could add supporting
          information to help reproduce and resolve the bug.</li>
        </ul>
        Search the Tomcat 3 bug database
        <a href="http://nagoya.apache.org/bugzilla/query.cgi?product=Tomcat%203";>
        here</a>.<br />
        Search the Tomcat 4 bug database
        <a href="http://nagoya.apache.org/bugzilla/query.cgi?product=Tomcat%204";>
        here</a>.<br />
      </p>
    </subsection>
  
    <subsection name="Tomcat discussion lists">
      <p>It is very likely you are not the first to run into a problem.
        Others may have already found a solution.  The <b>tomcat-user</b>
        or <b>tomcat-dev</b> list archives may contain discussions which
        will help you resolve the problem. Search the Tomcat User List archive
        <a href="http://www.mail-archive.com/tomcat-user@jakarta.apache.org/";>here</a>
        or <a href="http://mikal.org/interests/java/tomcat/index.html";>here</a>
        and the Tomcat Developer List archive
        <a href="http://www.mail-archive.com/tomcat-dev@jakarta.apache.org/";>here</a>
        or <a href="http://www.metronet.com/~wjm/tomcat/";>here</a>.
      </p>
      <p>If you have already subscribed to the
        <a href="mailto:[EMAIL PROTECTED]";>tomcat-user</a>
        or <a href="mailto:[EMAIL PROTECTED]";>tomcat-dev</a>
        discussion lists you can ask about the problem on those lists.
        If you are not subscribed, you can learn about the lists and subscribe
        <a herf="http://jakarta.apache.org/site/mail.html";>here</a>.
      </p>
    </subsection>
  
    <subsection name="Tomcat on IRC">
      <p>An IRC channel dedicated to Tomcat exists on OpenProjects.</p>
      
      <p><code>#tomcat</code> at <code>irc.us.openprojects.net</code>.
      Click <a href="irc://irc.us.openprojects.net/tomcat">here</a> to
      connect to the channel using Mozilla.</p>
    </subsection>
  
  </section>
  
  <section name="Reporting a Tomcat bug">
  <p>If after you have exhausted all other resources to resolve a problem
  with Tomcat you may want to file a bug report.  Please make sure the
  problem is a bug in Tomcat and not a bug in your web application.</p>
  
  <p>Please make sure you provide as much information as possible. Its
  very hard to fix a bug if the person looking into the problem can't
  reproduce it.  Here is a listing of information which should be included:
  <ul>
    <li><b>Version</b> - Tomcat version, if from a nightly build, version
      and date of build.</li>
    <li><b>Tomcat component</b> - Tomcat component which has the bug.</li>
    <li><b>Platform</b> - Hardward platform Tomcat is running on.</li>
    <li><b>OS</b> - Computer operating system and version.</li>
    <li><b>JVM</b> - JVM Version</li>
    <li><b>Web Server</b> - Web Server and version, Tomcat Connector and version.</li>
    <li><b>Configuration</b> - Attach configuration files if they would help track
      down the bug.</li>
    <li><b>Log file excerpts</b> - Review your logs files, reproduce the bug with
      debugging enabled in your Tomcat configuration.  Then submit any relevant
      sections of the log which help document the bug.</li>
    <li><b>Stack Traces</b> - Any stack traces generated by the bug.</li>
    <li><b>Example</b> - Example configuration files or web applications which
      demonstrate the bug.  When submitting an example which reproduces the bug,
      please try to make it as simple as possible.</li>
    <li><b>Bug Fix Patch</b> - A patch created using diff -u which fixes the bug.
      (If you have found a bug fixwhich can be applied to the Tomcat code)</li>
    <li><b>Miscellaneous</b> - Any other information you feel will help track
      down the problem.  For example other Java API's and versions being used
      with Tomcat.</li>
  </ul>
  
  Report a Tomcat 4 bug
  <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%204";>
  here</a>.<br />
  Report a Tomcat 3 bug
  <a href="http://nagoya.apache.org/bugzilla/enter_bug.cgi?product=Tomcat%203";>
  here</a>.<br />
  </p>
  </section>
  
  </body>
  </document>
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to