pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From msahy...@apache.org
Subject svn commit: r1625937 - /pdfbox/cmssite/trunk/content/support.mdtext
Date Thu, 18 Sep 2014 10:56:44 GMT
Author: msahyoun
Date: Thu Sep 18 10:56:43 2014
New Revision: 1625937

URL: http://svn.apache.org/r1625937
Log:
PDFBOX-2340 Provide additional support information

Modified:
    pdfbox/cmssite/trunk/content/support.mdtext

Modified: pdfbox/cmssite/trunk/content/support.mdtext
URL: http://svn.apache.org/viewvc/pdfbox/cmssite/trunk/content/support.mdtext?rev=1625937&r1=1625936&r2=1625937&view=diff
==============================================================================
--- pdfbox/cmssite/trunk/content/support.mdtext (original)
+++ pdfbox/cmssite/trunk/content/support.mdtext Thu Sep 18 10:56:43 2014
@@ -2,31 +2,49 @@ Title:     Support
 
 ## How to get support
 
-If you have questions about using PDFBox or you are experiencing problems 
-then please use the Mailing Lists to report your problem. This will get you help from the

-entire community.
+### Questions about How to use PDFBox
 
-If you are sure you have found a bug the please report the problem in our 
-[Issue Tracker](https://issues.apache.org/jira/browse/PDFBOX). 
+If you have questions about how to use PDFBox do ask on the [Users Mailing List](../mailinlists.html
"Subsribe to Mailing List"). This will get you help from the entire community.
+
+The PDFBox examples and the test code in the sources will also provide additional information.
+
+And there are additonal resources available on sites such as [Stack Overflow](http://stackoverflow.com/search?q=pdfbox
"Stack Overflow").
+
+
+### Filing a bug report or enhancement request
 
 <p class="alert alert-info">Please refrain from immediately opening a ticket in the
issue tracker unless 
 you are really certain it's a problem in the PDFBox software. Try using the Mailing Lists

 before.</p>
 
-### Before submitting a bug report
+If you are sure you have found a bug the please report the problem in our 
+[Issue Tracker](https://issues.apache.org/jira/browse/PDFBOX). 
 
-Before you submit a bug there are several things you can try first
+**Before you submit a bug there are several things you can try first**
 
  - for issues with text extraction try if Adobe Reader can extract the text
  - try the latest SNAPSHOT to see if it's fixed in the pre-release
  - search the mailing list to see if has been discussed before
  - check the issue tracker to see if the issue has already been reported
 
-### When reporting a bug
+**To help us resolving a bug quicker**
 
-You can help us resolving a bug quicker if
+ - attach the PDF that makes trouble by using "More", "Attach files" in the issue tracker
+ - if your file is too large, upload it to a sharehoster, or use the PDFSplit application
to isolate the troublesome page
+ - mention the PDFBox version you are using.
+ - attach the shortest possible code that reproduces the problem. Insert java code between
{code}...{code}. Or try to reproduce the problem with the command line applications.
+ - mention what you were doing, what was the expected behaviour, and what happened instead
+ - provide a stack trace of an exception if there is one
+ - try using the non-sequential parser (loadNonSeq() instead of load(), and "-nonSeq" with
the command line applications)
+ - search JIRA if your problem has been mentioned before.
+ - Be patient: all the people here are unpaid volunteers who work for you in their free time
+
+**And please DON'T**
+
+ - upload files to a hoster that requires registration to read the file.
+ - create an issue in JIRA and then go on vacation so you won't repond to our questions /
suggestions.
+ - ask "how to" questions in JIRA. Ask such questions on the mailing lists, on stackoverflow.com,
and look at the sample and the test code in the sources.
+ - attach PDF files with confidential and/or personal data (name, DoB, bank data, health
data, SSN) without getting permission from the client and/or the people mentioned on the PDF
+ - create issues about obsolete PDFBox versions
 
- - you submit the code to reproduce the bug
- - you submit the additional files such as PDFs which are needed to reproduce the bug
- - you submit provide the information which version of the libs you are using, the platform
you are running on etc
- - and if you could provide a patch for the bug that's a very welcome help for our small
team
\ No newline at end of file
+<p class="alert alert-info">We can sometimes solve problems without having the PDF,
but it is difficult.</p>



Mime
View raw message