Plugin documentation

[Wendy Smoak <ws...@gmail.com>]

The plugin documentation is improving, but there's a wealth of
information being posted to the user list that gets lost in the
archives.  In my opinion, you're missing out on some great
contributions by not promoting the Wiki as a first class citizen of
the documentation.

What do you think of adding a link to a companion Wiki page for each plugin?

For example, the Javadoc Plugin's configuration page  doesn't cover
how to use the <link> element.  I answered a question and added it to
the wiki [2].  However, that information is all but invisible.

I'd also advocate removing that 'user contributed documentation'
disclaimer.  Instead, say something *positive* about the fact that the
user community contributes to the documentation.

[1] http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html
[2] http://docs.codehaus.org/display/MAVENUSER/Javadoc+Plugin

Thanks,
-- 
Wendy

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org

Re: Plugin documentation

[Brett Porter <br...@apache.org>]

I'm going to start a separate thread on documentation.

- Brett

Wendy Smoak wrote:
> The plugin documentation is improving, but there's a wealth of
> information being posted to the user list that gets lost in the
> archives.  In my opinion, you're missing out on some great
> contributions by not promoting the Wiki as a first class citizen of
> the documentation.
> 
> What do you think of adding a link to a companion Wiki page for each 
> plugin?
> 
> For example, the Javadoc Plugin's configuration page  doesn't cover
> how to use the <link> element.  I answered a question and added it to
> the wiki [2].  However, that information is all but invisible.
> 
> I'd also advocate removing that 'user contributed documentation'
> disclaimer.  Instead, say something *positive* about the fact that the
> user community contributes to the documentation.
> 
> [1] http://maven.apache.org/plugins/maven-javadoc-plugin/configuration.html
> [2] http://docs.codehaus.org/display/MAVENUSER/Javadoc+Plugin
> 
> Thanks,


-- 
Brett Porter <br...@apache.org>
Apache Maven - http://maven.apache.org/
Better Builds with Maven - http://library.mergere.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org