Like a little "howto" read this documentation. I think it's good.
+1
On 22-Aug-08, at 2:46 AM, Benjamin Bentmann wrote:
Hi,
I would like to propose the following update (excluding typos ;-) )
to the index.apt template given in the Plugin Documentation Standard
[0]:
* Usage
General instructions on how to use the Plugin Name can be found on
the {{{usage.html}usage page}}. Some more
specific use cases are described in the examples given below.
In case you still have questions regarding the plugin's usage,
please have a look at the {{{faq.html}FAQ}} and feel
free to contact the {{{mail-lists.html}user mailing list}}. The
posts to the mailing list are archived and could
already contain the answer to your question as part of an older
thread. Hence, it is also worth browsing/searching
the mail archive.
If you feel like the plugin is missing a feature or has a defect,
you can fill a feature request or bug report in our
{{{issue-tracking.html}issue tracker}}. When creating a new issue,
please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the
developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects
attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out
the project from our
{{{source-repository.html}source repository}} and will find
supplementary information in the
{{{http://maven.apache.org/guides/development/guide-
helping.html}guide to helping with Maven}}.
The intention is to provide more of the "interesting" links directly
on the index page to ease the site navigation. See [1] for a live
example.
What do you think?
Benjamin
[0] http://maven.apache.org/guides/development/guide-plugin-documentation.html
[1] http://people.apache.org/~bentmann/maven/pds/
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
jason at sonatype dot com
----------------------------------------------------------
Script timed out
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]