You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2007/07/24 23:22:56 UTC
svn commit: r559221 - /maven/site/trunk/src/site/apt/users/getting-help.apt
Author: dennisl
Date: Tue Jul 24 14:22:55 2007
New Revision: 559221
URL: http://svn.apache.org/viewvc?view=rev&rev=559221
Log:
o First draft of a more user-oriented guide to how users can help us help them. Please comment on this.
Added:
maven/site/trunk/src/site/apt/users/getting-help.apt (with props)
Added: maven/site/trunk/src/site/apt/users/getting-help.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/users/getting-help.apt?view=auto&rev=559221
==============================================================================
--- maven/site/trunk/src/site/apt/users/getting-help.apt (added)
+++ maven/site/trunk/src/site/apt/users/getting-help.apt Tue Jul 24 14:22:55 2007
@@ -0,0 +1,83 @@
+ -----
+ Getting Help
+ -----
+ Dennis Lundberg
+ -----
+ 2007-07-24
+ -----
+
+
+Getting Help
+
+ So something didn't work as you expected it to? You think that
+ <Maven is broken>. What should you do?
+
+ Here's an list of actions that you can take:
+
+*You did check the documentation, didn't you?
+
+ Apart from the central Maven site, each of our plugins has a website. Go
+ to the {{{../plugins/index.html}plugins page}} and follow the link to the
+ plugin you are having problems with.
+
+*Search the user-list archives
+
+ Someone else might have experienced the same problem as you before. A list
+ of mail-archives can be found on
+ {{{http://maven.apache.org/mail-lists.html}this page}}. Please search one of
+ them before going any further.
+
+*Ask on the user list
+
+ Our community is very helpful, just ask it the right way. See the references
+ section, at the end of this page, for info on how to do that. Subscribe to
+ the {{{http://maven.apache.org/mail-lists.html}users-list}} and describe your
+ problem there. Don't expect to get an answer right away. Sometimes it takes a
+ couple of days.
+
+*Submit an issue
+
+ If it turns out that there is indeed something wrong with Maven or one of
+ the plugins, you should report it to our issue management system JIRA.
+
+ First of all you need to create an account in JIRA. This is so that we can
+ communicate with you while we work together on the issue. Go
+ {{{http://jira.codehaus.org/secure/Signup!default.jspa}here}} to create an
+ account if you don't already have one.
+
+**Where?
+
+ If the problem is in one of the plugins, check the site of that plugin to
+ get the correct link. Each plugin has its own section in JIRA, so using the
+ correct link is important. Click on <Project Information> and then
+ <Issue Tracking>. On that page you will find the correct link.
+
+ If the problem is in Maven itself you can find the link on
+ {{{http://maven.apache.org/issue-tracking.html}this page}}.
+
+**How?
+
+ Just describing the problem is not enough. It takes a developer a lot of
+ time to make a usable POM to even attempt to assess the problem. Issues
+ that states problems without something usable to try out will be closed as
+ incomplete.
+
+ Please attach a working POM, or a set of POMs, that we can download and run.
+ We appreciate reports, but if you don't have something usable for us it's
+ incredibly hard for us to manage the issues. A POM goes a long way to helping
+ us resolve problems.
+
+ Create a POM that can be used to verify that it is a bug. If your pom uses
+ plugins, make sure that you have specified the version for each of the
+ plugins. If you don't, then we might not be using the same version as you are
+ when we test it.
+
+ What we like best are patches that fixes the problem. If you want to create a
+ patch for an issue please read
+ {{{../guides/development/guide-m2-development.html}this document}} first.
+
+* References
+
+ * {{{http://www.catb.org/~esr/faqs/smart-questions.html}How To Ask Questions The Smart Way}}
+
+ * {{{http://opensourcestrategies.blogspot.com/2005/09/how-to-get-support-from-open-source.html}How to Get Support from Open Source Mailing Lists}}
Propchange: maven/site/trunk/src/site/apt/users/getting-help.apt
------------------------------------------------------------------------------
svn:eol-style = native
Re: svn commit: r559221 - /maven/site/trunk/src/site/apt/users/getting-help.apt
Posted by Dennis Lundberg <de...@apache.org>.
My plan was to add a link in the menu under "User Centre" and on the
page http://maven.apache.org/users/index.html
Renaming "Getting Support" to "Getting Help" in the menu sounds good as
well. We can do both. Plus add an entry in the FAQ about it.
There is already links to mail-lists.html on this page.
Vincent Siveton wrote:
> Hi Dennis,
>
> Sounds very useful for users. Thanks!
>
> My only comment is where to put a link! FAQ? Renamed the "Getting
> Support" page to it, with a link to mail-lists.html?
>
> Cheers,
>
> Vincent
>
> 2007/7/24, dennisl@apache.org <de...@apache.org>:
>> Author: dennisl
>> Date: Tue Jul 24 14:22:55 2007
>> New Revision: 559221
>>
>> URL: http://svn.apache.org/viewvc?view=rev&rev=559221
>> Log:
>> o First draft of a more user-oriented guide to how users can help us
>> help them. Please comment on this.
>>
>
> [SNIP]
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: svn commit: r559221 - /maven/site/trunk/src/site/apt/users/getting-help.apt
Posted by Vincent Siveton <vi...@gmail.com>.
Hi Dennis,
Sounds very useful for users. Thanks!
My only comment is where to put a link! FAQ? Renamed the "Getting
Support" page to it, with a link to mail-lists.html?
Cheers,
Vincent
2007/7/24, dennisl@apache.org <de...@apache.org>:
> Author: dennisl
> Date: Tue Jul 24 14:22:55 2007
> New Revision: 559221
>
> URL: http://svn.apache.org/viewvc?view=rev&rev=559221
> Log:
> o First draft of a more user-oriented guide to how users can help us help them. Please comment on this.
>
[SNIP]
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org