[LOGBack-dev] svn commit: r460 - logback/trunk/logback-site/src/site/xdocTemplates

Fri Aug 11 11:31:46 CEST 2006

Author: seb
Date: Fri Aug 11 11:31:45 2006
New Revision: 460

Modified:
   logback/trunk/logback-site/src/site/xdocTemplates/bugreport.xml
   logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml
Log:
- updated bugreport.xml introduction
- spelling fix on documentation.xml

Modified: logback/trunk/logback-site/src/site/xdocTemplates/bugreport.xml
==============================================================================

--- logback/trunk/logback-site/src/site/xdocTemplates/bugreport.xml	(original)
+++ logback/trunk/logback-site/src/site/xdocTemplates/bugreport.xml	Fri Aug 11 11:31:45 2006
@@ -2,13 +2,60 @@
 <document>
 
 <body>
-  <h2>Bug reporting</h2>
+<h2>Before you report a bug</h2>
 
-  <p>The logback project uses a bugzilla based management system to
-  track bugs.</p>
+<p>
+The logback community consists of those who use logback and its modules, 
+help answer questions on discussions lists, contribute documentation and patches, 
+and those who develop and maintain the code for logback and its modules. 
+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 logback, but are due to misconfiguration, 
+problems caused by installed applications, the operating system, etc.
+</p>
+<p>
+Before reporting a bug please make every effort to resolve the problem yourself. 
+Just reporting a bug will not fix it. A good bug report includes a detailed description 
+of the problem and a succinct test case which can reproduce the problem.
+</p>
 
-  <p>You can report and follow logback bugs by following <a
-  href="http://bugzilla.qos.ch/">this link</a>.</p>
+<h3>Review the documentation</h3>
+<p>
+Review the documentation for the version of component you are using. 
+The problem you are having may already be addressed in the docs.
+</p>
+
+<h3>Search the mailing list archives</h3>
+<p>
+It is very likely you are not the first to run into a problem. 
+Others may have already found a solution. 
+Our various mailing lists are likely to have discussed this problem before.
+</p>
+
+<h3>Search Bugzilla</h3>
+
+<p>
+Please search the bug database to see if the bug you are seeing has already been reported. 
+The bug may have already been fixed and is available in a later version. 
+If someone else has reported the same bug, you could add supporting information to help reproduce and resolve the bug.
+</p>
+<ul>
+	<li><a href="http://bugzilla.qos.ch/query.cgi">Search for logback bugs</a></li>
+</ul>
+
+<h2>Reporting with Bugzilla</h2>
+<p>
+Only after you have exhausted the aforementioned steps, should you file a formal report in bugzilla.
+</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.
+</p>
+<ul>
+    <li><a href="http://bugzilla.qos.ch/enter_bug.cgi">Report new logback bug</a></li>
+</ul>
   
 
 

Modified: logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml
==============================================================================
--- logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml	(original)
+++ logback/trunk/logback-site/src/site/xdocTemplates/documentation.xml	Fri Aug 11 11:31:45 2006
@@ -3,7 +3,7 @@
 
 	<properties>
 		<author email="ceki at qos ddoott ch ">Ceki Gulcu</author>
-		<title>Documentaions</title>
+		<title>Documentations</title>
 	</properties>
 
 	<body>

