You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Alexandre Poitras <al...@gmail.com> on 2006/03/18 04:56:26 UTC
Maven tutorial
Well I don't know if anyone has noticed but I have been working on
some Maven 2 documentation lately
http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
I would like to hear your comments and suggestions since I am planning
to try to finish it in the coming weeks. In my opinion, the format is
more user-friendly at first then the sparsed documentation currently
available. What do you think?
--
Alexandre Poitras
Québec, Canada
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven tutorial
Posted by Alexandre Poitras <al...@gmail.com>.
Thank for correcting my spelling mistakes, english isn't my native
language. About the images, I have used Open Office Draw to create the
images so I'll upload all the source files. This way everyone can
change the text easily. I'll try continue writting more this week, I
haven't had a lot of time lately .
On 4/8/06, Dennis Lundberg <de...@apache.org> wrote:
> I have just read through the docs that Alexandre has written and there
> is good stuff in there. The content is presented in a fashion similar to
> "The Java Tutorial" with trails. One trail for each level of knowledge:
> beginner, intermediate, etc. This is a nice way to do it and I think
> that this is precisely what the current Maven docs lack. Sure there are
> a ton of information on the Maven site, but to the novice user it's
> somewhat overwhelming. Having a "beginners trail" will make it easier
> for newbies.
>
> I took the liberty of proofreading the wiki docs, making some minor
> changes to spelling and formatting. There are still some minor errors,
> but they are in the very nice-looking images. It'd probably be best for
> someone who has the original images to correct those.
>
> As far as reintegration goes, I think it can be done. But it depends on
> the status of the support for wiki/confluence in doxia and the site
> plugin. If that is not available, a bit of conversion will be required.
>
> --
> Dennis Lundberg
>
> Brett Porter wrote:
> > Has anyone had a chance to look at the wiki content? It seems to be
> > coming along, but I'm too pressed for time right now...
> >
> > Are any docs able to be reintegrated back into the Maven site?
> >
> > - Brett
> >
> > Alexandre Poitras wrote:
> >> Thank Brett, I'll do my best.
> >> In the first part, where I explain basic concepts, I sometimes
> >> reproduce some of the already existing content but I always try to
> >> make the explanations clearer and add some details. Sometimes the
> >> existing documentation is good but presented in a very rude way. And
> >> lets not forget that a tutorial promotes a natural reading order,
> >> which is very important to not confuse new users.
> >>
> >> Other then that, I don't think I will take a lot of already existing content.
> >>
> >>
> >> On 3/19/06, Brett Porter <br...@apache.org> wrote:
> >>> I plan to take a look when I get some time. The important things I'd
> >>> keep in mind:
> >>> - don't just reproduce documentation that already exists (like
> >>> installation instructions). The last attempt at a tutorial on the wiki
> >>> did this and then just petered out as it wasn't very useful. This
> >>> doesn't appear to be the case here, just a thing to keep in mind.
> >>> - have in the back of your mind how you'd integrate it into the project
> >>> web site. This should give a structure that facilitates doing so later.
> >>>
> >>> Thanks!
> >>> - Brett
> >>>
> >>> Alexandre Poitras wrote:
> >>>> Well I don't know if anyone has noticed but I have been working on
> >>>> some Maven 2 documentation lately
> >>>> http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
> >>>>
> >>>> I would like to hear your comments and suggestions since I am planning
> >>>> to try to finish it in the coming weeks. In my opinion, the format is
> >>>> more user-friendly at first then the sparsed documentation currently
> >>>> available. What do you think?
> >>>>
> >>>> --
> >>>> Alexandre Poitras
> >>>> Québec, Canada
> >>>>
> >>>> ---------------------------------------------------------------------
> >>>> 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
> >>>
> >>>
> >>
> >> --
> >> Alexandre Poitras
> >> Québec, Canada
> >>
> >> ---------------------------------------------------------------------
> >> 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
> >
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
> For additional commands, e-mail: dev-help@maven.apache.org
>
>
--
Alexandre Poitras
Québec, Canada
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven tutorial
Posted by Dennis Lundberg <de...@apache.org>.
I have just read through the docs that Alexandre has written and there
is good stuff in there. The content is presented in a fashion similar to
"The Java Tutorial" with trails. One trail for each level of knowledge:
beginner, intermediate, etc. This is a nice way to do it and I think
that this is precisely what the current Maven docs lack. Sure there are
a ton of information on the Maven site, but to the novice user it's
somewhat overwhelming. Having a "beginners trail" will make it easier
for newbies.
I took the liberty of proofreading the wiki docs, making some minor
changes to spelling and formatting. There are still some minor errors,
but they are in the very nice-looking images. It'd probably be best for
someone who has the original images to correct those.
As far as reintegration goes, I think it can be done. But it depends on
the status of the support for wiki/confluence in doxia and the site
plugin. If that is not available, a bit of conversion will be required.
--
Dennis Lundberg
Brett Porter wrote:
> Has anyone had a chance to look at the wiki content? It seems to be
> coming along, but I'm too pressed for time right now...
>
> Are any docs able to be reintegrated back into the Maven site?
>
> - Brett
>
> Alexandre Poitras wrote:
>> Thank Brett, I'll do my best.
>> In the first part, where I explain basic concepts, I sometimes
>> reproduce some of the already existing content but I always try to
>> make the explanations clearer and add some details. Sometimes the
>> existing documentation is good but presented in a very rude way. And
>> lets not forget that a tutorial promotes a natural reading order,
>> which is very important to not confuse new users.
>>
>> Other then that, I don't think I will take a lot of already existing content.
>>
>>
>> On 3/19/06, Brett Porter <br...@apache.org> wrote:
>>> I plan to take a look when I get some time. The important things I'd
>>> keep in mind:
>>> - don't just reproduce documentation that already exists (like
>>> installation instructions). The last attempt at a tutorial on the wiki
>>> did this and then just petered out as it wasn't very useful. This
>>> doesn't appear to be the case here, just a thing to keep in mind.
>>> - have in the back of your mind how you'd integrate it into the project
>>> web site. This should give a structure that facilitates doing so later.
>>>
>>> Thanks!
>>> - Brett
>>>
>>> Alexandre Poitras wrote:
>>>> Well I don't know if anyone has noticed but I have been working on
>>>> some Maven 2 documentation lately
>>>> http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
>>>>
>>>> I would like to hear your comments and suggestions since I am planning
>>>> to try to finish it in the coming weeks. In my opinion, the format is
>>>> more user-friendly at first then the sparsed documentation currently
>>>> available. What do you think?
>>>>
>>>> --
>>>> Alexandre Poitras
>>>> Québec, Canada
>>>>
>>>> ---------------------------------------------------------------------
>>>> 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
>>>
>>>
>>
>> --
>> Alexandre Poitras
>> Québec, Canada
>>
>> ---------------------------------------------------------------------
>> 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
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven tutorial
Posted by Brett Porter <br...@apache.org>.
Has anyone had a chance to look at the wiki content? It seems to be
coming along, but I'm too pressed for time right now...
Are any docs able to be reintegrated back into the Maven site?
- Brett
Alexandre Poitras wrote:
> Thank Brett, I'll do my best.
> In the first part, where I explain basic concepts, I sometimes
> reproduce some of the already existing content but I always try to
> make the explanations clearer and add some details. Sometimes the
> existing documentation is good but presented in a very rude way. And
> lets not forget that a tutorial promotes a natural reading order,
> which is very important to not confuse new users.
>
> Other then that, I don't think I will take a lot of already existing content.
>
>
> On 3/19/06, Brett Porter <br...@apache.org> wrote:
>> I plan to take a look when I get some time. The important things I'd
>> keep in mind:
>> - don't just reproduce documentation that already exists (like
>> installation instructions). The last attempt at a tutorial on the wiki
>> did this and then just petered out as it wasn't very useful. This
>> doesn't appear to be the case here, just a thing to keep in mind.
>> - have in the back of your mind how you'd integrate it into the project
>> web site. This should give a structure that facilitates doing so later.
>>
>> Thanks!
>> - Brett
>>
>> Alexandre Poitras wrote:
>>> Well I don't know if anyone has noticed but I have been working on
>>> some Maven 2 documentation lately
>>> http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
>>>
>>> I would like to hear your comments and suggestions since I am planning
>>> to try to finish it in the coming weeks. In my opinion, the format is
>>> more user-friendly at first then the sparsed documentation currently
>>> available. What do you think?
>>>
>>> --
>>> Alexandre Poitras
>>> Québec, Canada
>>>
>>> ---------------------------------------------------------------------
>>> 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
>>
>>
>
>
> --
> Alexandre Poitras
> Québec, Canada
>
> ---------------------------------------------------------------------
> 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: Maven tutorial
Posted by Alexandre Poitras <al...@gmail.com>.
Thank Brett, I'll do my best.
In the first part, where I explain basic concepts, I sometimes
reproduce some of the already existing content but I always try to
make the explanations clearer and add some details. Sometimes the
existing documentation is good but presented in a very rude way. And
lets not forget that a tutorial promotes a natural reading order,
which is very important to not confuse new users.
Other then that, I don't think I will take a lot of already existing content.
On 3/19/06, Brett Porter <br...@apache.org> wrote:
> I plan to take a look when I get some time. The important things I'd
> keep in mind:
> - don't just reproduce documentation that already exists (like
> installation instructions). The last attempt at a tutorial on the wiki
> did this and then just petered out as it wasn't very useful. This
> doesn't appear to be the case here, just a thing to keep in mind.
> - have in the back of your mind how you'd integrate it into the project
> web site. This should give a structure that facilitates doing so later.
>
> Thanks!
> - Brett
>
> Alexandre Poitras wrote:
> > Well I don't know if anyone has noticed but I have been working on
> > some Maven 2 documentation lately
> > http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
> >
> > I would like to hear your comments and suggestions since I am planning
> > to try to finish it in the coming weeks. In my opinion, the format is
> > more user-friendly at first then the sparsed documentation currently
> > available. What do you think?
> >
> > --
> > Alexandre Poitras
> > Québec, Canada
> >
> > ---------------------------------------------------------------------
> > 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
>
>
--
Alexandre Poitras
Québec, Canada
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org
Re: Maven tutorial
Posted by Brett Porter <br...@apache.org>.
I plan to take a look when I get some time. The important things I'd
keep in mind:
- don't just reproduce documentation that already exists (like
installation instructions). The last attempt at a tutorial on the wiki
did this and then just petered out as it wasn't very useful. This
doesn't appear to be the case here, just a thing to keep in mind.
- have in the back of your mind how you'd integrate it into the project
web site. This should give a structure that facilitates doing so later.
Thanks!
- Brett
Alexandre Poitras wrote:
> Well I don't know if anyone has noticed but I have been working on
> some Maven 2 documentation lately
> http://docs.codehaus.org/display/MAVENUSER/The+Maven+2+tutorial
>
> I would like to hear your comments and suggestions since I am planning
> to try to finish it in the coming weeks. In my opinion, the format is
> more user-friendly at first then the sparsed documentation currently
> available. What do you think?
>
> --
> Alexandre Poitras
> Québec, Canada
>
> ---------------------------------------------------------------------
> 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