All,

While I appreciate the feedback, can I offer some suggestions on the
most effective way to give it...

Regarding the book from Mergere:
- send book feedback to [EMAIL PROTECTED] (same as for submitting
errata, see the front of the book)

Regarding the separate Maven documentation efforts:
- take a look at prior discussions on this list
- particularly take a look at recent discussions on
[email protected] that talk about our current plan of action with
respect to the Maven documentation
- avoid "me too" comments, please. We've read it all before and we are
working on it (and you are welcome to help!)

If I could highlight how this is being approached:
- a lot of people are working on the plugin documentation, and there
is a standard format [1]
- there are a number of proposals for improving the site entrance and
navigation, eg [2]
- there are some other tasks up for grabs [3]
- there is a wiki anyone can contribute to. We eventually hope to
better structure this as a cookbook area that will be sucked directly
into a segment of the Maven site [4]

Thanks!
- Brett

[1] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation
[2] http://mail-archives.apache.org/mod_mbox/maven-dev/200606.mbox/[EMAIL 
PROTECTED]
[3] http://mail-archives.apache.org/mod_mbox/maven-dev/200606.mbox/[EMAIL 
PROTECTED]
[4] http://docs.codehaus.org/display/MAVENUSER/Home

On 17/07/06, Matilda Robert <[EMAIL PROTECTED]> wrote:
Hi,

I agree.  I have been working with Maven 2.0 for a little over three months
now and reading the book is extremely complex.  I use the text as a guide
and post my questions to the user groups and find results either here or
online through other resources.  I look to a variety of maven 2.0 web sites
to find out svn commands that work in mvn and cargo plugins.  I took all of
my troubleshooting issues and created a log on it so that whenever I have a
problem that I have seen before I just look at my guide to solve it.  Last
week I had a problem with a cargo command and thought that my file was
corrupted, looking in the M2 user guide text my url was correct but through
using this user list I found out that the cargo plugin that I was using was
out of date.  I believe that something like this should be posted.  I
actually found this at http://cargo.codehaus.org/Maven2+plugin this website.


There is a lot of information online for maven so don't just limit yourself
directly to the book.  I found that blogs also help.  This is open source
material so we have to treat it as such, extra research is involved in
getting the pom.xml file to work correctly.  I also found that the
dependencies aren't complete for all programs like weblogic, but are
completed in others.  These are things that I figured out after days of
programming and finding weird error messages only to find out that there
weren't plugins for that software yet.  I guess one learns from experience
right.  I hope that some of this information can help others that are new to
Maven so that they know that the user guide is just that a guide and not the
only source for information.

Matilda


-----Original Message-----
From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]
Sent: Monday, July 17, 2006 8:29 AM
To: Maven Users List
Subject: Re: Maven book: feedback

Have been following this thread with interest.

One of my biggest issues with maven 2 is that the documentation is very
poor. Yes, I know there is a book on it, but I did not find the book very
helpful...

The maven book takes a far too high level approach and does not give
detailed instructions on how to use particular plugins.

For instance, I was looking at getting a maven to build, test and deploy a
site with a few basic reports - jdepends, checkstyle and javadoc.

It was in fact very difficult. I had to post to the group to find out how
to download jdepends.

A simple, step by step, "getting started with maven 2" or "maven 2 by
example", is the kind of thing I think is required. The maven book while
valuable is not as hands on as I'd like, nor does it give any details
about how to use particular plugins.

The maven 2 documentation in general is not great. Some kind of wiki/cms
approach would I feel be the best way to improve this situation. i.e. let
the community contribute to the documentation. The head knowledge is
definitely out there, this mailing list bears testimony to that.

One area where I think things can be greatly improved is in documentation
on the settings.xml - yes, there is a page on it, but it is not very
detailed. A sample settings.xml would be a good start.

Maven is a great tool, it would be a pity to slow its adoption because of
documentation, especially as the knowledge is out there.

Michael Wiles
Java Developer


Disclaimer
Sanlam Life Insurance Limited Reg no 1998/021121/06 - Licensed Financial
Services Provider
Disclaimer and Directors


-----------------------------------------
Attention:
Any views expressed in this message are those of the individual
sender, except where the message states otherwise and the sender is
authorized to state them to be the views of any such entity. The
information contained in this message and or attachments is
intended only for the person or entity to which it is addressed and
may contain confidential and/or privileged material.  If you
received this in error, please contact the sender and delete the
material from any system and destroy any copies.


---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]




--
Apache Maven - http://maven.apache.org
"Better Builds with Maven" book - http://library.mergere.com/

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to