You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by Franz Allan Valencia See <fr...@gmail.com> on 2006/07/25 14:02:38 UTC

Maven Archetype Plugin Documentation needs Reviewing

Good day,

I would like to ask for some help reviewing the Maven Archetype Plugin
Documentation.

The documentation can be viewed
here<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>,
while the Jira Issue can be viewed
here<http://jira.codehaus.org/browse/ARCHETYPE-45>
.

Btw, I assumed that archetypes profiles and simple are still work in
progress. I am not really sure what the purpose of maven-archetype-profiles
is, but as of the moment, the results of archetype:create for profiles is
the same as that of quickstart. And as for maven-archetype-simple, the
source code seems to be in archetype:create-from-project format, which is
also a work in progress.

Moreover, maven-archetype-portlet still has a bug when this documentation
was created. However, I've already submitted a patch in its jira
issue<http://jira.codehaus.org/browse/ARCHETYPE-40>to make it work
again.

Also, I would like to suggest that the Apache Maven's Guide to Creating
Archetypes<http://maven.apache.org/guides/mini/guide-creating-archetypes.html>and
Introduction
to Archetypes<http://maven.apache.org/guides/introduction/introduction-to-archetypes.html>be
transfered in the Maven
Archetype Plugin
Documentation<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>(under
examples<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/examples/archetype.html>and
FAQ<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/faq.html>respectivelly).

Thanks,
Franz

Re: Maven Archetype Plugin Documentation needs Reviewing

Posted by Franz Allan Valencia See <fr...@gmail.com>.
Hello Allan,

Thank you for your comments. I've already created another patch (the second
"ARCHETYPE-45-maven-archetype-plugin.patch") applying most of your comments
plus a few others. Here are the changes:

In the whole docu
Applied monospacing font format on all commands, goals, parameters, and
texts (tags, values, urls).
changed all instances of "work in progress" to "currently under development"
changed all instances of "proect" and projecct" to "project"

In MavenArchetypeMojo.java
changed "Once the archetype is retrieve it is process " to "Once the
archetype is retrieved, it is then processed "

In usage.html
removed "The Archetype Plugin has two goals: create and
create-from-project."
included more information regarding the other parameters of the "create"
goal and their defaults
elaborated on how a specific archetype is chosen by the "create" goal

In index.html
changed "Once the archetype is retrieve it is process " to "Once the
archetype is retrieved, it is then processed "
changed "against a st of user" to "against a set of user"
changed "Resources Plugin" to "Archetype Plugin"
changed "Javadoc Plugin" to "Archetype Plugin"

In mojo.html
changed "ues" to "use"

In remote-repositories.html
changed "-D expression" to "property / parameter"

In site.html
included more info regarding the APT Format, and provided a link towards the
APT Format Guide.

Unapplied Comment:
In usage.html
changing of "specific directory structure" to "maven recommended directory
structure"
...this was not applied because the directory structure i am referring to is
the directory structure created by maven-archetype-plugin. And it does not
necessarily mean that the directory structure produced by the plugin would
follow maven's recommended directory structure.

On 7/27/06, Allan Ramirez <ar...@exist.com> wrote:
>
> Hi Franz,
>
> Nice work with the plugin. Here are my comments
>
> ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>
> index.html
>
> + work in progress -> currently under development
>
> Under Goals Overview section:
>
> + Once the archetype is retrieve it is process -> Once the archetype is
> retrieved it is processed
> + against a st of user -> Typo for "st" It should be "set"
>
>
> Under Usage section:
>
> + Change the Resources Plugin to Archetype Plugin
>
> Under Examples
>
> + examples show how to use the Javadoc Plugin -> examples show how to
> use the Archetype Plugin
>
>
> usage.html
>
> + I think the statement "The Archetype Plugin has two goals: create and
> create-from-project" should be removed, since
>   it is already mentioned in the Goals Overview section.
>
> + specific directory structure -> maven recommended directory structure
>
> + I think you also need to mention that by calling the said command, by
> default, maven will use the
> maven-archetype-quickstart (wdyt?)
>
>
> remote-repositories.html
>
> + use the remoteRepositories -D expression -> use the remoteRepositories
> property/parameter (in italic or monospace
> font)
>
> site.html
>
> + and it will generate a maven projecct  -> and it will generate a maven
> project
> + This would then create a maven proect -> This would then create a
> maven project
> + you could also add a link to the guide to apt
> format(http://maven.apache.org/guides/mini/guide-apt-format.html) from
> here
>
> j2ee-simple.html
>
> + This would then create a maven proect - >This would then create a
> maven project
>
> webapp.html
>
> + This would then create a maven proect - >This would then create a
> maven project
>
> portlet.html
>
> + This would then create a maven proect - >This would then create a
> maven project
>
> mojo.html
>
> + you can ues -> you can use
> + This would then create a maven proect - >This would then create a
> maven project
>
>
> Cheers,
> allan
>
> Maria Odea Ching wrote:
> > Hi Everyone,
> >
> > I've moved the archetype plugin staging site to
> > http://people.apache.org/~oching/maven-archetype-plugin
> > <http://people.apache.org/%7Eoching/maven-archetype-plugin>.
> > There seems to be a problem with the geocities site.
> >
> > Thanks,
> > Odea
> >
> > Franz Allan Valencia See wrote:
> >
> >> Good day,
> >>
> >> I would like to ask for some help reviewing the Maven Archetype Plugin
> >> Documentation.
> >>
> >> The documentation can be viewed
> >> here<
> http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/
> >,
> >>
> >> while the Jira Issue can be viewed
> >> here<http://jira.codehaus.org/browse/ARCHETYPE-45>
> >> .
> >>
> >> Btw, I assumed that archetypes profiles and simple are still work in
> >> progress. I am not really sure what the purpose of
> >> maven-archetype-profiles
> >> is, but as of the moment, the results of archetype:create for
> >> profiles is
> >> the same as that of quickstart. And as for maven-archetype-simple, the
> >> source code seems to be in archetype:create-from-project format,
> >> which is
> >> also a work in progress.
> >>
> >> Moreover, maven-archetype-portlet still has a bug when this
> >> documentation
> >> was created. However, I've already submitted a patch in its jira
> >> issue<http://jira.codehaus.org/browse/ARCHETYPE-40>to make it work
> >> again.
> >>
> >> Also, I would like to suggest that the Apache Maven's Guide to Creating
> >> Archetypes<
> http://maven.apache.org/guides/mini/guide-creating-archetypes.html>and
> >>
> >> Introduction
> >> to
> >> Archetypes<
> http://maven.apache.org/guides/introduction/introduction-to-archetypes.html
> >be
> >>
> >> transfered in the Maven
> >> Archetype Plugin
> >> Documentation<
> http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/
> >(under
> >>
> >> examples<
> http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/examples/archetype.html
> >and
> >>
> >> FAQ<
> http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/faq.html
> >respectivelly).
> >>
> >>
> >> Thanks,
> >> Franz
> >>
> >
> >
> > ---------------------------------------------------------------------
> > 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 Archetype Plugin Documentation needs Reviewing

Posted by Allan Ramirez <ar...@exist.com>.
Hi Franz,

Nice work with the plugin. Here are my comments

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

index.html

+ work in progress -> currently under development

Under Goals Overview section:

+ Once the archetype is retrieve it is process -> Once the archetype is 
retrieved it is processed
+ against a st of user -> Typo for "st" It should be "set"


Under Usage section:

+ Change the Resources Plugin to Archetype Plugin

Under Examples

+ examples show how to use the Javadoc Plugin -> examples show how to 
use the Archetype Plugin


usage.html

+ I think the statement "The Archetype Plugin has two goals: create and 
create-from-project" should be removed, since
  it is already mentioned in the Goals Overview section.

+ specific directory structure -> maven recommended directory structure

+ I think you also need to mention that by calling the said command, by 
default, maven will use the
maven-archetype-quickstart (wdyt?)


remote-repositories.html

+ use the remoteRepositories -D expression -> use the remoteRepositories 
property/parameter (in italic or monospace
font)

site.html

+ and it will generate a maven projecct  -> and it will generate a maven 
project
+ This would then create a maven proect -> This would then create a 
maven project
+ you could also add a link to the guide to apt 
format(http://maven.apache.org/guides/mini/guide-apt-format.html) from
here

j2ee-simple.html

+ This would then create a maven proect - >This would then create a 
maven project

webapp.html

+ This would then create a maven proect - >This would then create a 
maven project

portlet.html

+ This would then create a maven proect - >This would then create a 
maven project

mojo.html

+ you can ues -> you can use
+ This would then create a maven proect - >This would then create a 
maven project


Cheers,
allan

Maria Odea Ching wrote:
> Hi Everyone,
>
> I've moved the archetype plugin staging site to 
> http://people.apache.org/~oching/maven-archetype-plugin 
> <http://people.apache.org/%7Eoching/maven-archetype-plugin>.
> There seems to be a problem with the geocities site.
>
> Thanks,
> Odea
>
> Franz Allan Valencia See wrote:
>
>> Good day,
>>
>> I would like to ask for some help reviewing the Maven Archetype Plugin
>> Documentation.
>>
>> The documentation can be viewed
>> here<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>, 
>>
>> while the Jira Issue can be viewed
>> here<http://jira.codehaus.org/browse/ARCHETYPE-45>
>> .
>>
>> Btw, I assumed that archetypes profiles and simple are still work in
>> progress. I am not really sure what the purpose of 
>> maven-archetype-profiles
>> is, but as of the moment, the results of archetype:create for 
>> profiles is
>> the same as that of quickstart. And as for maven-archetype-simple, the
>> source code seems to be in archetype:create-from-project format, 
>> which is
>> also a work in progress.
>>
>> Moreover, maven-archetype-portlet still has a bug when this 
>> documentation
>> was created. However, I've already submitted a patch in its jira
>> issue<http://jira.codehaus.org/browse/ARCHETYPE-40>to make it work
>> again.
>>
>> Also, I would like to suggest that the Apache Maven's Guide to Creating
>> Archetypes<http://maven.apache.org/guides/mini/guide-creating-archetypes.html>and 
>>
>> Introduction
>> to 
>> Archetypes<http://maven.apache.org/guides/introduction/introduction-to-archetypes.html>be 
>>
>> transfered in the Maven
>> Archetype Plugin
>> Documentation<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>(under 
>>
>> examples<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/examples/archetype.html>and 
>>
>> FAQ<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/faq.html>respectivelly). 
>>
>>
>> Thanks,
>> Franz
>>
>
>
> ---------------------------------------------------------------------
> 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 Archetype Plugin Documentation needs Reviewing

Posted by Maria Odea Ching <oc...@exist.com>.
Hi Everyone,

I've moved the archetype plugin staging site to 
http://people.apache.org/~oching/maven-archetype-plugin 
<http://people.apache.org/%7Eoching/maven-archetype-plugin>.
There seems to be a problem with the geocities site.

Thanks,
Odea

Franz Allan Valencia See wrote:

> Good day,
>
> I would like to ask for some help reviewing the Maven Archetype Plugin
> Documentation.
>
> The documentation can be viewed
> here<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>, 
>
> while the Jira Issue can be viewed
> here<http://jira.codehaus.org/browse/ARCHETYPE-45>
> .
>
> Btw, I assumed that archetypes profiles and simple are still work in
> progress. I am not really sure what the purpose of 
> maven-archetype-profiles
> is, but as of the moment, the results of archetype:create for profiles is
> the same as that of quickstart. And as for maven-archetype-simple, the
> source code seems to be in archetype:create-from-project format, which is
> also a work in progress.
>
> Moreover, maven-archetype-portlet still has a bug when this documentation
> was created. However, I've already submitted a patch in its jira
> issue<http://jira.codehaus.org/browse/ARCHETYPE-40>to make it work
> again.
>
> Also, I would like to suggest that the Apache Maven's Guide to Creating
> Archetypes<http://maven.apache.org/guides/mini/guide-creating-archetypes.html>and 
>
> Introduction
> to 
> Archetypes<http://maven.apache.org/guides/introduction/introduction-to-archetypes.html>be 
>
> transfered in the Maven
> Archetype Plugin
> Documentation<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/>(under 
>
> examples<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/examples/archetype.html>and 
>
> FAQ<http://www.geocities.com/see_franz_allan_valencia/maven/staging-site/maven-archetype-plugin/faq.html>respectivelly). 
>
>
> Thanks,
> Franz
>


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