[ http://jira.codehaus.org/browse/MWAR-48?page=comments#action_68209 ] 

Brett Porter commented on MWAR-48:
----------------------------------

I have applied this, but would like further revision:
- need an index.html
- introduction should be usage.html
- replace 'm2' with 'mvn' in examples
- incorrect formatting of <<<packaging>>>
- version of 1.0-SNAPSHOT, not 0.0 which is not a very sensible example
- instead of talking about modes, talk about "use cases":
  * WAR as a packaging type
  * building a WAR from the command line (note that they need to have 
previously run package to compile classes, etc)
  * building an exploded WAR from the command line (note that they need to have 
previously run package to compile classes, etc)
  * building a WAR in place from the command line
- remove defaults at bottom of page - the reference page lists these (and will 
be improved later)
- better explanatory text at the top (the part about it being error prone is 
irrelevant - nobody does things by hand in Maven)
- use <code style> for things like pom.xml, WEB-INF/lib, target/..., etc
- remove the example for putting inplace in the pom, it makes no sense
- for the directory diagrams, consider using 'tree': available for cygwin here: 
http://lassauge.free.fr/cygwin/release/
- be careful with boilerplating documents. Some of these have inconsistencies 
that have been copy+pasted.
- the example links are broken
- choose shorter, more concise names for the examples
- FAQ should be a normal menu item, not a header.


> review plugin documentation
> ---------------------------
>
>          Key: MWAR-48
>          URL: http://jira.codehaus.org/browse/MWAR-48
>      Project: Maven 2.x War Plugin
>         Type: Task

>     Versions: 2.0
>     Reporter: Marvin King
>     Assignee: Marvin King
>  Attachments: MWAR-48-maven-war-plugin[draft2].patch, 
> MWAR-48-maven-war-plugin[draft].patch
>
>   Time Spent: 15 hours
>    Remaining: 0 minutes
>


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira

Reply via email to