[jbpm-commits] JBoss JBPM SVN: r5322 - jbpm4/trunk/modules/userguide/src/main/docbook/en/modules.

[do-not-reply at jboss.org]

Author: tom.baeyens at jboss.com
Date: 2009-07-17 06:33:36 -0400 (Fri, 17 Jul 2009)
New Revision: 5322

Modified:
   jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml
Log:
updated section 'reporting problems'

Modified: jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml
===================================================================
--- jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml	2009-07-17 10:24:39 UTC (rev 5321)
+++ jbpm4/trunk/modules/userguide/src/main/docbook/en/modules/ch01-Introduction.xml	2009-07-17 10:33:36 UTC (rev 5322)
@@ -61,27 +61,31 @@
     <para>When reporting a problem in the user forum or in our support portal, please 
     use the following snippet as a template:
     </para>
-    <programlisting><emphasis role="bold">Environment:</emphasis>
-<emphasis role="bold"> - jBPM Version:</emphasis> which version of jBPM are you using?
-<emphasis role="bold"> - Database:</emphasis> which database and which version of that database
-<emphasis role="bold"> - JDK:</emphasis> which Java version are you using? use 'java -version' to find out
-<emphasis role="bold"> - Container:</emphasis> which Java version are you using? use 'java -version' to find out
-<emphasis role="bold"> - Configuration:</emphasis> is your jbpm.cfg.xml only importing files from the jbpm.jar 
-   lib itself?  or did you create a custom config file?
-<emphasis role="bold"> - Libraries:</emphasis> are you using the exact versions of the libs from inside the jbpm 
+    <programlisting><emphasis role="bold">=== Environment ==============================</emphasis>
+ - <emphasis role="bold">jBPM Version</emphasis> : which version of jBPM are you using?
+ - <emphasis role="bold">Database</emphasis> : which database and which version of that database
+ - <emphasis role="bold">JDK</emphasis> : which Java version are you using? use 'java -version' to find out
+ - <emphasis role="bold">Container</emphasis> : which Java version are you using? use 'java -version' to find out
+ - <emphasis role="bold">Configuration</emphasis> : is your jbpm.cfg.xml only importing files from the jbpm.jar
+   lib itself? or did you create a custom config file?
+ - <emphasis role="bold">Libraries</emphasis> : are you using the exact versions of the libs from inside the jbpm
    distribution of the version that you're using? or did you change some of the libs?
 
-<emphasis role="bold">Process:</emphasis> 
+<emphasis role="bold">=== Process ==================================</emphasis>
 past jPDL process here
 
-<emphasis role="bold">API:</emphasis> 
+<emphasis role="bold">=== API ===================================</emphasis>
 past the relevant code snippet that you use to invoke jBPM
 
-<emphasis role="bold">Stacktrace:</emphasis> 
+<emphasis role="bold">=== Stacktrace ==============================</emphasis>
 past full stack trace here
 
-<emphasis role="bold">Debug logs:</emphasis> 
-past debug logs here</programlisting>
+<emphasis role="bold">=== Debug logs ==============================</emphasis>
+past debug logs here
+
+<emphasis role="bold">=== Problem description =========================</emphasis>
+Keep this part short and to the point. E.g. API doesn't work as expected. 
+or e.g. method ExecutionService.signalExecutionById throws exception.</programlisting>
     <para>Clever readers will have noticed that some of these questions point to probably causes :-)
     Especially tweaking the libs and configuration can easily lead to trouble.  That's why 
     we have spend a great deal of effort to include default installations and a simplified