On 13-Jun-08, at 3:50 PM, Dennis Lundberg wrote:
Hi
I'm in the process of converting the Ant builds, at my day job, to
use Maven Ant tasks for dependency management. This is my first
contact with Maven Ant tasks so I gave the doc a thorough reading
and made some corrections and alterations. The doc is currently only
one page [1] and is part of the maven site.
The page is very long and tries to cover everything there is to know
about the Ant tasks. Unfortunately it doesn't cover everything, as
I've seen going through the user list trying to find answers. So I'd
like to make some changes to the documentation.
1. Move the docs from maven site to the Ant tasks, in subversion.
+1
2. Split up the current one page into several more focused pages.
+1
Also take a look at simplifications that can be made. When I converted
the bootstrap to use the Ant Tasks I found the number of options
overwhelming and confusing. I'm wondering really how many use cases
there are. Who needs more then the POM really.
3. Create a reference section, similar in function to the
documentation for Ant, to make it easier for Ant (=non-Maven) users
to find their way.
Thoughts, ideas, criticism?
I think if you make the documentation generally approachable I don't
think you need to make it look like the Ant documentation.
For 3 I thought I'd have a look at how Ant currently generates its
own documentation. One possibility would be to use annotations and
create a Maven plugin to extract those along with Javadoc to create
general documentation for Ant tasks (not just the Maven Ant tasks).
This would work similarly to how the plugin-plugin works on Maven
plugins.
Is this a feasible approach or just a waste of time?
[1] http://maven.apache.org/ant-tasks.html
--
Dennis Lundberg
---------------------------------------------------------------------
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
----------------------------------------------------------
Selfish deeds are the shortest path to self destruction.
-- The Seven Samuari, Akira Kirosawa
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
