You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Hervé BOUTEMY <he...@free.fr> on 2008/07/13 12:50:42 UTC
Re: [DISCUSS] The documentation for Maven Ant Tasks
Dennis,
I created MANTTASKS-114 to track the issue.
Did you start any work on this on your side?
regards,
Hervé
Le samedi 14 juin 2008, Dennis Lundberg a écrit :
> 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.
>
> 2. Split up the current one page into several more focused pages.
>
> 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?
>
>
> 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
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [DISCUSS] The documentation for Maven Ant Tasks
Posted by Jason van Zyl <ja...@maven.org>.
Whatever we choose we should try to be consistent with the paths we
use in SVN. So we have "ant-tasks" in SVN, so it probably makes sense
to try and keep the same pattern for the site URL.
On 18-Jul-08, at 5:50 PM, Vincent Siveton wrote:
> Hi,
>
> 2008/7/18, Dennis Lundberg <de...@apache.org>:
>> I've committed most of the stuff I had in mind, although there are
>> still a
>> few TODOs in the site documents. Would you mind having a look at
>> those
>> Hervé?
>>
>> We also need to decide the URL for the site. If we don't configure
>> anything
>> it will end up at http://maven.apache.org/maven-ant-tasks/
>> Is that OK or do we want it at another URL?
>
> I am fine with http://maven.apache.org/ant-tasks/ ie without maven
>
> Cheers,
>
> Vincent
>
>>
>> Hervé BOUTEMY wrote:
>>
>>> Le dimanche 13 juillet 2008, Dennis Lundberg a écrit :
>>>
>>>> Hervé BOUTEMY wrote:
>>>>
>>>>> Dennis,
>>>>>
>>>>> I created MANTTASKS-114 to track the issue.
>>>>>
>>>> Thanks for doing that!
>>>>
>>>>
>>>>> Did you start any work on this on your side?
>>>>>
>>>> I have some sketches and ideas. Also I wrote a little java
>>>> program that
>>>> iterates through a list of Task classes and prints out the
>>>> different
>>>> parameters, to make sure that no parameter is missed.
>>>>
>>>> I was meaning to get back about this to discuss where to put the
>>>> docs.
>>>> My plan is to put them in the 2.0.x branch, since that's what
>>>> people are
>>>> using today. How does that sound?
>>>>
>>> +1
>>>
>>>
>>>> If we agree I'll commit what I have now and we can work from there.
>>>>
>>> yes, please
>>>
>>>
>>>>
>>>>> regards,
>>>>>
>>>>> Hervé
>>>>>
>>>>> Le samedi 14 juin 2008, Dennis Lundberg a écrit :
>>>>>
>>>>>> 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.
>>>>>>
>>>>>> 2. Split up the current one page into several more focused pages.
>>>>>>
>>>>>> 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?
>>>>>>
>>>>>>
>>>>>> 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
>>>>>>
>>>>>
>> ---------------------------------------------------------------------
>>>>> To unsubscribe, e-mail:
>> dev-unsubscribe@maven.apache.org
>>>>> For additional commands, e-mail: dev-help@maven.apache.org
>>>>>
>>>>
>>>
>>>
>>>
>>>
>> ---------------------------------------------------------------------
>>> 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
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder, Apache Maven
jason at sonatype dot com
----------------------------------------------------------
believe nothing, no matter where you read it,
or who has said it,
not even if i have said it,
unless it agrees with your own reason
and your own common sense.
-- Buddha
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [DISCUSS] The documentation for Maven Ant Tasks
Posted by Vincent Siveton <vi...@gmail.com>.
Hi,
2008/7/18, Dennis Lundberg <de...@apache.org>:
> I've committed most of the stuff I had in mind, although there are still a
> few TODOs in the site documents. Would you mind having a look at those
> Hervé?
>
> We also need to decide the URL for the site. If we don't configure anything
> it will end up at http://maven.apache.org/maven-ant-tasks/
> Is that OK or do we want it at another URL?
I am fine with http://maven.apache.org/ant-tasks/ ie without maven
Cheers,
Vincent
>
> Hervé BOUTEMY wrote:
>
> > Le dimanche 13 juillet 2008, Dennis Lundberg a écrit :
> >
> > > Hervé BOUTEMY wrote:
> > >
> > > > Dennis,
> > > >
> > > > I created MANTTASKS-114 to track the issue.
> > > >
> > > Thanks for doing that!
> > >
> > >
> > > > Did you start any work on this on your side?
> > > >
> > > I have some sketches and ideas. Also I wrote a little java program that
> > > iterates through a list of Task classes and prints out the different
> > > parameters, to make sure that no parameter is missed.
> > >
> > > I was meaning to get back about this to discuss where to put the docs.
> > > My plan is to put them in the 2.0.x branch, since that's what people are
> > > using today. How does that sound?
> > >
> > +1
> >
> >
> > > If we agree I'll commit what I have now and we can work from there.
> > >
> > yes, please
> >
> >
> > >
> > > > regards,
> > > >
> > > > Hervé
> > > >
> > > > Le samedi 14 juin 2008, Dennis Lundberg a écrit :
> > > >
> > > > > 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.
> > > > >
> > > > > 2. Split up the current one page into several more focused pages.
> > > > >
> > > > > 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?
> > > > >
> > > > >
> > > > > 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
> > > > >
> > > >
> ---------------------------------------------------------------------
> > > > To unsubscribe, e-mail:
> dev-unsubscribe@maven.apache.org
> > > > For additional commands, e-mail: dev-help@maven.apache.org
> > > >
> > >
> >
> >
> >
> >
> ---------------------------------------------------------------------
> > 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
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [DISCUSS] The documentation for Maven Ant Tasks
Posted by Dennis Lundberg <de...@apache.org>.
I've committed most of the stuff I had in mind, although there are still
a few TODOs in the site documents. Would you mind having a look at those
Hervé?
We also need to decide the URL for the site. If we don't configure
anything it will end up at http://maven.apache.org/maven-ant-tasks/
Is that OK or do we want it at another URL?
Hervé BOUTEMY wrote:
> Le dimanche 13 juillet 2008, Dennis Lundberg a écrit :
>> Hervé BOUTEMY wrote:
>>> Dennis,
>>>
>>> I created MANTTASKS-114 to track the issue.
>> Thanks for doing that!
>>
>>> Did you start any work on this on your side?
>> I have some sketches and ideas. Also I wrote a little java program that
>> iterates through a list of Task classes and prints out the different
>> parameters, to make sure that no parameter is missed.
>>
>> I was meaning to get back about this to discuss where to put the docs.
>> My plan is to put them in the 2.0.x branch, since that's what people are
>> using today. How does that sound?
> +1
>
>> If we agree I'll commit what I have now and we can work from there.
> yes, please
>
>>> regards,
>>>
>>> Hervé
>>>
>>> Le samedi 14 juin 2008, Dennis Lundberg a écrit :
>>>> 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.
>>>>
>>>> 2. Split up the current one page into several more focused pages.
>>>>
>>>> 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?
>>>>
>>>>
>>>> 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
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
>>> For additional commands, e-mail: dev-help@maven.apache.org
>
>
>
> ---------------------------------------------------------------------
> 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: [DISCUSS] The documentation for Maven Ant Tasks
Posted by Hervé BOUTEMY <he...@free.fr>.
Le dimanche 13 juillet 2008, Dennis Lundberg a écrit :
> Hervé BOUTEMY wrote:
> > Dennis,
> >
> > I created MANTTASKS-114 to track the issue.
>
> Thanks for doing that!
>
> > Did you start any work on this on your side?
>
> I have some sketches and ideas. Also I wrote a little java program that
> iterates through a list of Task classes and prints out the different
> parameters, to make sure that no parameter is missed.
>
> I was meaning to get back about this to discuss where to put the docs.
> My plan is to put them in the 2.0.x branch, since that's what people are
> using today. How does that sound?
+1
>
> If we agree I'll commit what I have now and we can work from there.
yes, please
>
> > regards,
> >
> > Hervé
> >
> > Le samedi 14 juin 2008, Dennis Lundberg a écrit :
> >> 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.
> >>
> >> 2. Split up the current one page into several more focused pages.
> >>
> >> 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?
> >>
> >>
> >> 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
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> > For additional commands, e-mail: dev-help@maven.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: [DISCUSS] The documentation for Maven Ant Tasks
Posted by Dennis Lundberg <de...@apache.org>.
Hervé BOUTEMY wrote:
> Dennis,
>
> I created MANTTASKS-114 to track the issue.
Thanks for doing that!
> Did you start any work on this on your side?
I have some sketches and ideas. Also I wrote a little java program that
iterates through a list of Task classes and prints out the different
parameters, to make sure that no parameter is missed.
I was meaning to get back about this to discuss where to put the docs.
My plan is to put them in the 2.0.x branch, since that's what people are
using today. How does that sound?
If we agree I'll commit what I have now and we can work from there.
>
> regards,
>
> Hervé
>
> Le samedi 14 juin 2008, Dennis Lundberg a écrit :
>> 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.
>>
>> 2. Split up the current one page into several more focused pages.
>>
>> 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?
>>
>>
>> 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
>
>
>
> ---------------------------------------------------------------------
> 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