Index: webapp/index/community/contributing.page =================================================================== --- webapp/index/community/contributing.page (revision 1147591) +++ webapp/index/community/contributing.page (working copy) @@ -6,11 +6,11 @@ --- pipeline:conf There are many ways you can help make Karaf a better piece of software - please dive in and help\! -Try surf the documentation - if somethings confusing or not clear, let us know. Download the code & try it out and see what you think. Browse the source code. Got an itch to scratch, want to tune some operation or add some feature? +Try browsing the documentation - if something's confusing or not clear, let us know. Download the code & try it out and see what you think. Browse the source code. Got an itch to scratch, want to tune some operation or add some feature? -Want to do some hacking on Karaf? Try surfing the our [issue tracker|http://issues.apache.org/jira/browse/KARAF] for open issues or features that need to be implemented, take ownership of an issue and try fix it. +Want to do some hacking on Karaf? Try surfing the our [issue tracker|http://issues.apache.org/jira/browse/KARAF] for open issues or features that need to be implemented. Take ownership of an issue and try fix it. -If you'd rather a more gentle introduction to working on the Karaf project, how about you try look at the +If you'd rather have a more gentle introduction to working on the Karaf project, try looking at the {link:test coverage report|http://nemo.sonar.codehaus.org/project/index/XXXX} and help us get it even more green by supplying more test cases to get us closer to 100% coverage. h2. Getting in touch @@ -22,21 +22,19 @@ h2. Improving the documentation -Documentation is massively important to help users make the most of Apache Karaf and its probably the area that needs the most help\! +Documentation is massively important to help users make the most of Apache Karaf and it's probably the area that needs the most help\! So if you are interested in helping the documentation effort; whether its just to fix a page here or there, correct a link or even write a tutorial or improve what documentation is already there please do dive in and help\! -All of the documentation is stored on the wiki. See [How does the website work] or [How do I edit the website] for more details. +See [How does the website work] or [How do I edit the website] for more details. -To be able to edit the wiki you need to mail the [dev list|Mailing Lists] asking for an account (to prevent spam we only offer access to the wiki by folks sending mail to the mailing list). - h2. If you find a bug or problem Please raise a new issue in our [issue tracker|http://issues.apache.org/jira/browse/KARAF] -If you can create a JUnit test case then your issue is more likely to be resolved quicker. +If you can create a JUnit test case then your issue is more likely to be resolved quickly. -Then we can add your issue to Subversion and then we'll know when its really fixed and we can ensure that the problem stays fixed in future releases. +Also, we can add your test case to Subversion and then we'll know when it's really fixed and we can ensure that the problem stays fixed in future releases. h2. Working on the code @@ -50,7 +48,7 @@ {code} mvn install {code} -PS: You might need to build multiple times (if you get a build error) because sometimes maven fails to download all the files. +PS: You might need to build multiple times (if you get a build error) because sometimes Maven fails to download all the files. Then import the projects into your workspace. Index: webapp/index/community/tips-for-getting-help.page =================================================================== --- webapp/index/community/tips-for-getting-help.page (revision 1147591) +++ webapp/index/community/tips-for-getting-help.page (working copy) @@ -12,8 +12,8 @@ Here are a few tips to help us to help you: -* which version of Karaf are you using? (and if you are using a SNAPSHOT, which date?) -* details of your environment can help too such as +* Which version of Karaf are you using? (and if you are using a SNAPSHOT, which date?) +* Details of your environment can help too such as ** operating system ** JVM version (1.5 or 1.6) -* if you have an exception, include the *full* stack trace +* If you have an exception, include the *full* stack trace Index: webapp/index/community/discussion-forums.page =================================================================== --- webapp/index/community/discussion-forums.page (revision 1147591) +++ webapp/index/community/discussion-forums.page (working copy) @@ -8,7 +8,7 @@ Before posting you might want to read the [Tips for getting help]. -Many users prefer to use online forums rather than joining a mail list which can lead to lots more email traffic so we use the online forums at [Nabble forums|http://karaf.922171.n3.nabble.com/] which also work with our [Mailing Lists] so that both stay completely in sync. Use either the mailing lists or online forums, its completely up to you. +Many users prefer to use online forums rather than joining a mail list which can lead to lots more email traffic so we use the online forums at [Nabble forums|http://karaf.922171.n3.nabble.com/] which also work with our [Mailing Lists] so that both stay completely in sync. Use either the mailing lists or online forums, it's completely up to you. h3. [Karaf Forums|http://karaf.922171.n3.nabble.com/] @@ -17,4 +17,4 @@ h3. Mailing Lists -If you prefer to use a mailing list instead then check out our [Mailing Lists]. Note that the Forums and [Mailing Lists] are kept in sync so its your choice which you use. \ No newline at end of file +If you prefer to use a mailing list instead then check out our [Mailing Lists]. Note again that the Forums and [Mailing Lists] are kept in sync so it's your choice which you use. \ No newline at end of file Index: webapp/index/community/support.page =================================================================== --- webapp/index/community/support.page (revision 1147591) +++ webapp/index/community/support.page (working copy) @@ -17,23 +17,23 @@ Before you report a problem you might want to read the [FAQ]. Whenever you are reporting a problem please be sure to include as much information as possible; the more we know the more chance of a quicker resolution. -* *which version of the software* -* what platform and JDK? -* any particulary container being used - if so what version -* stack traces generally really help! If in doubt include the whole thing; often exceptions get wrapped in other exceptions and the exception right near the bottom explains the actual error, not the first few lines at the top. It's very easy for us to skim-read past unnecessary parts of a stack trace. -* log output can be useful too; sometimes [enabling DEBUG logging|How do I change the logging] can help -* your code & configuration files are often useful -* did it work before, what have you changed to break it -* try upgrading to the latest release and see if its fixed in that release -* try the latest SNAPSHOT to see if its fixed in that release -* search the user forum to see if has been discussed before -* see the knowns issues section in the release notes -* and check the [issue tracker|http://issues.apache.org/jira/browse/KARAF] if the issue already have been reported +* *Which Karaf version you're using* +* What platform and JDK? +* The particular OSGi container being used - if so what version +* Stack traces generally really help! If in doubt include the whole thing; often exceptions get wrapped in other exceptions and the exception right near the bottom explains the actual error, not the first few lines at the top. It's very easy for us to skim-read past unnecessary parts of a stack trace. +* Log output can be useful too; sometimes [enabling DEBUG logging|How do I change the logging] can help +* Your code & configuration files are often useful. Be careful not to send us anything of a sensitive nature. +* Did it work before, what have you changed to break it? +* Try upgrading to the latest release and see if its fixed in that release +* Try the latest SNAPSHOT to see if its fixed in that release +* Search the user forum to see if has been discussed before +* See the Known Issues section in the Release Notes for the Karaf version you're using +* Check the [issue tracker|http://issues.apache.org/jira/browse/KARAF] to see if the issue already have been reported h3. How to get help faster -We can help you much quicker if you try the following +We may be able to help you much more quickly if you try the following -* provide us with a JUnit test case that demonstrates your issue. e.g. if you think you've found a bug, can you create a test case to demonstrate the bug? -* [submit a patch|Contributing] fixing the bug! (We also buy you beer when we meet you if you submit bug fixes :) ) -* for memory leak or performance related issues, if you can run a profiler on your test case and attach the output as a file (or zipped file if it's huge) to the JIRA we can normally fix things much faster. e.g. you could run [jmap|http://java.sun.com/j2se/1.5.0/docs/tooldocs/share/jmap.html]/[jhat|http://java.sun.com/javase/6/docs/technotes/tools/share/jhat.html], JProfiler or YourKit on your code and send us the output. To find memory leaks it's quicker to resolve if you can tell us what classes are taking up all of the RAM; we can normally figure out what's wrong from that. +* Provide us with a JUnit test case that demonstrates your issue. e.g. if you think you've found a bug, can you create a test case to demonstrate the bug? +* [Submit a patch|Contributing] fixing the bug! (We also buy you beer when we meet you if you submit bug fixes :) ) +* For memory leak or performance related issues, if you can run a profiler on your test case and attach the output as a file (or zipped file if it's huge) to the JIRA we can normally fix things much more quickly. E.g. you could run [jmap|http://java.sun.com/j2se/1.5.0/docs/tooldocs/share/jmap.html]/[jhat|http://java.sun.com/javase/6/docs/technotes/tools/share/jhat.html], JProfiler or YourKit on your code and send us the output. To find memory leaks it's quicker to resolve if you can tell us what classes are consuming excessive RAM; we can normally figure out what's wrong from that.