You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Alexander Hars <do...@inventivio.com> on 2005/11/08 13:53:27 UTC

Guide to creating archetypes

Hi,

Two weeks ago I wrote a significantly expanded Guide to Creating 
Archetypes. It was immediately posted to CVS, but it is still not 
available on the website.

Is there some reason why the Maven2 site is not updated regularly (last 
update was 10/21). Shouldn't it be very easy using Maven2?
I am sure that lots of  improvements have been made to the documentation 
in the last weeks.

The documentation is really essential for all us newbies to Maven2 and 
it would help very much if you could update the site.

Thank you very much
 Alexander


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


Re: Guide to creating archetypes

Posted by Wim Deblauwe <wi...@gmail.com>.
2005/11/8, Jason van Zyl <ja...@maven.org>:
>
> On Tue, 2005-11-08 at 13:53 +0100, Alexander Hars wrote:
> > Hi,
> >
> > Two weeks ago I wrote a significantly expanded Guide to Creating
> > Archetypes. It was immediately posted to CVS, but it is still not
> > available on the website.
>
> http://maven.apache.org/guides/mini/guide-creating-archetypes.html
>
> Is that not it?
>

What I miss there is what archetype.xml contains in the META-INF directory.
That does not seem to get explained.

regards,

Wim

Re: Guide to creating archetypes

Posted by Jason van Zyl <ja...@maven.org>.
On Tue, 2005-11-08 at 13:53 +0100, Alexander Hars wrote:
> Hi,
> 
> Two weeks ago I wrote a significantly expanded Guide to Creating 
> Archetypes. It was immediately posted to CVS, but it is still not 
> available on the website.

http://maven.apache.org/guides/mini/guide-creating-archetypes.html

Is that not it?

> Is there some reason why the Maven2 site is not updated regularly (last 
> update was 10/21). Shouldn't it be very easy using Maven2?

mvn site-deploy

> I am sure that lots of  improvements have been made to the documentation 
> in the last weeks.

It is usually deployed once a day if not more.

> The documentation is really essential for all us newbies to Maven2 and 
> it would help very much if you could update the site.

We usually update the site when changes are made, but like all human
beings we sometimes miss things. If the guide you are referring does not
have the expected content just let me know.

> Thank you very much
>  Alexander
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
> 
-- 
jvz.

Jason van Zyl
jason at maven.org
http://maven.apache.org

Our achievements speak for themselves. What we have to keep track
of are our failures, discouragements and doubts. We tend to forget
the past difficulties, the many false starts, and the painful
groping. We see our past achievements as the end result of a
clean forward thrust, and our present difficulties as
signs of decline and decay.

 -- Eric Hoffer, Reflections on the Human Condition


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


Re: Guide to creating archetypes

Posted by Jason van Zyl <ja...@maven.org>.
On Tue, 2005-11-08 at 08:02 -0500, Richard Allen wrote:
> I second that one. My biggest stumbling block so far with adopting Maven 
> has been lack of documentation. However, I do understand how difficult 
> it can be to get the docs written.

If there is something lacking then it is best to use one of the four
components we have for documentation:

http://jira.codehaus.org/secure/BrowseProject.jspa

As far as the site goes I've tried to make the first quick links give a
clear path to the documentation if that is lacking just let us know:

Features
Download 
Installation Instructions 
Getting Started 
Documentation
Available Plug-ins 
Plug-in Matrix
Where is it?

The plug-in matrix is particularly helpful when looking for specific
things you need and we now have 34 mini guides, and 11 guides on
introductory material. We can only help with users' direction. Saying
there is a "lack of documentation" doesn't really help anyone. We need
to know where it is lacking in order to fix it.



> Richard
> 
> Alexander Hars wrote:
> 
> > Hi,
> >
> > Two weeks ago I wrote a significantly expanded Guide to Creating 
> > Archetypes. It was immediately posted to CVS, but it is still not 
> > available on the website.
> >
> > Is there some reason why the Maven2 site is not updated regularly 
> > (last update was 10/21). Shouldn't it be very easy using Maven2?
> > I am sure that lots of  improvements have been made to the 
> > documentation in the last weeks.
> >
> > The documentation is really essential for all us newbies to Maven2 and 
> > it would help very much if you could update the site.
> >
> > Thank you very much
> > Alexander
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
> >
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
> 
-- 
jvz.

Jason van Zyl
jason at maven.org
http://maven.apache.org

Our achievements speak for themselves. What we have to keep track
of are our failures, discouragements and doubts. We tend to forget
the past difficulties, the many false starts, and the painful
groping. We see our past achievements as the end result of a
clean forward thrust, and our present difficulties as
signs of decline and decay.

 -- Eric Hoffer, Reflections on the Human Condition


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


Re: Guide to creating archetypes

Posted by Anuerin Diaz <ra...@gmail.com>.
On 11/8/05, Jason van Zyl <ja...@maven.org> wrote:
> On Tue, 2005-11-08 at 15:11 +0200, Anuerin Diaz wrote:
> > maybe we can use http://wiki.apache.org/maven/ for a collaborative
> > effort? there is no specific wiki site for maven2 but from what i can
> > see that wiki is relatively unused by maven1.
>
> Anyone is welcome to use the wiki but we have a decent pattern started
> for the doco. People can help by adding to the FAQs, creating mini
> guides and creating introductory guides. If they are placed in JIRA they
> are usually processed pretty quickly. Full documents if they are new are
> preferred and patches for everything else are greatly appreciated.
> Patches get absorbed pretty quickly.
>
> > finalized documents could then be promoted to the official site as the
> > maintainers see fit. not everybody has ready access to the development
> > branch so i guess there will be people who will benefit in this
> > effort.
>
> Unfortunately we don't have a very good work flow in place for this
> right now and JIRA is your best bet at the moment.
>

the way i see it is we can use JIRA as the official promotion vehicle.
documentation could be refined in the wikis by user comments and
suggestions and if no more flaws are detected then it could be
submitted to JIRA for inclusion on the main site. the wiki can also be
a repository of bits and pieces that are not "full-bodied" enough to
warrant their own mini-guide (e.g. a listing of all properties that
could be accessed in maven) .

another advantage of this approach is that the the rough drafts can
aid users find their way. although the downside is if the draft is
very rough it could make learning something more difficult than it
seems.

just an idea. :)

ciao!


--

"Programming, an artform that fights back"

Anuerin G. Diaz
Registered Linux User #246176
Friendly Linux Board @ http://mandrivausers.org/index.php
http://capsule.ramfree17.org , when you absolutely have nothing else
better to do

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


Re: Guide to creating archetypes

Posted by Jason van Zyl <ja...@maven.org>.
On Tue, 2005-11-08 at 15:11 +0200, Anuerin Diaz wrote:
> maybe we can use http://wiki.apache.org/maven/ for a collaborative
> effort? there is no specific wiki site for maven2 but from what i can
> see that wiki is relatively unused by maven1.

Anyone is welcome to use the wiki but we have a decent pattern started
for the doco. People can help by adding to the FAQs, creating mini
guides and creating introductory guides. If they are placed in JIRA they
are usually processed pretty quickly. Full documents if they are new are
preferred and patches for everything else are greatly appreciated.
Patches get absorbed pretty quickly.

> finalized documents could then be promoted to the official site as the
> maintainers see fit. not everybody has ready access to the development
> branch so i guess there will be people who will benefit in this
> effort.

Unfortunately we don't have a very good work flow in place for this
right now and JIRA is your best bet at the moment.

> ciao!
> 
> On 11/8/05, Richard Allen <ri...@gtri.gatech.edu> wrote:
> > I second that one. My biggest stumbling block so far with adopting Maven
> > has been lack of documentation. However, I do understand how difficult
> > it can be to get the docs written.
> >
> > Richard
> >
> > Alexander Hars wrote:
> >
> > > Hi,
> > >
> > > Two weeks ago I wrote a significantly expanded Guide to Creating
> > > Archetypes. It was immediately posted to CVS, but it is still not
> > > available on the website.
> > >
> > > Is there some reason why the Maven2 site is not updated regularly
> > > (last update was 10/21). Shouldn't it be very easy using Maven2?
> > > I am sure that lots of  improvements have been made to the
> > > documentation in the last weeks.
> > >
> > > The documentation is really essential for all us newbies to Maven2 and
> > > it would help very much if you could update the site.
> > >
> > > Thank you very much
> > > Alexander
> > >
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > > For additional commands, e-mail: users-help@maven.apache.org
> > >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
> >
> >
> 
> 
> --
> 
> "Programming, an artform that fights back"
> 
> Anuerin G. Diaz
> Registered Linux User #246176
> Friendly Linux Board @ http://mandrivausers.org/index.php
> http://capsule.ramfree17.org , when you absolutely have nothing else
> better to do
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
> 
> 
-- 
jvz.

Jason van Zyl
jason at maven.org
http://maven.apache.org

Three people can keep a secret provided two of them are dead.

 -- Unknown


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


Re: Guide to creating archetypes

Posted by Anuerin Diaz <ra...@gmail.com>.
maybe we can use http://wiki.apache.org/maven/ for a collaborative
effort? there is no specific wiki site for maven2 but from what i can
see that wiki is relatively unused by maven1.

finalized documents could then be promoted to the official site as the
maintainers see fit. not everybody has ready access to the development
branch so i guess there will be people who will benefit in this
effort.

ciao!

On 11/8/05, Richard Allen <ri...@gtri.gatech.edu> wrote:
> I second that one. My biggest stumbling block so far with adopting Maven
> has been lack of documentation. However, I do understand how difficult
> it can be to get the docs written.
>
> Richard
>
> Alexander Hars wrote:
>
> > Hi,
> >
> > Two weeks ago I wrote a significantly expanded Guide to Creating
> > Archetypes. It was immediately posted to CVS, but it is still not
> > available on the website.
> >
> > Is there some reason why the Maven2 site is not updated regularly
> > (last update was 10/21). Shouldn't it be very easy using Maven2?
> > I am sure that lots of  improvements have been made to the
> > documentation in the last weeks.
> >
> > The documentation is really essential for all us newbies to Maven2 and
> > it would help very much if you could update the site.
> >
> > Thank you very much
> > Alexander
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>
>


--

"Programming, an artform that fights back"

Anuerin G. Diaz
Registered Linux User #246176
Friendly Linux Board @ http://mandrivausers.org/index.php
http://capsule.ramfree17.org , when you absolutely have nothing else
better to do

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


Re: Guide to creating archetypes

Posted by Richard Allen <ri...@gtri.gatech.edu>.
I second that one. My biggest stumbling block so far with adopting Maven 
has been lack of documentation. However, I do understand how difficult 
it can be to get the docs written.

Richard

Alexander Hars wrote:

> Hi,
>
> Two weeks ago I wrote a significantly expanded Guide to Creating 
> Archetypes. It was immediately posted to CVS, but it is still not 
> available on the website.
>
> Is there some reason why the Maven2 site is not updated regularly 
> (last update was 10/21). Shouldn't it be very easy using Maven2?
> I am sure that lots of  improvements have been made to the 
> documentation in the last weeks.
>
> The documentation is really essential for all us newbies to Maven2 and 
> it would help very much if you could update the site.
>
> Thank you very much
> Alexander
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org
>


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