> -----Original Message----- > From: Wayne Fay [mailto:[EMAIL PROTECTED] > Sent: Thursday, September 27, 2007 11:05 AM > To: Maven Users List > Subject: Re: Improving Maven Site Docs (was maven is hard) > > Hi Johan, [Johan Iskandar] Hi Wayne,
> > I was actually talking about this exact same concept hmm a couple > weeks ago now on IRC with some other people in #maven. I suggested > that Perldoc is a good example to follow for Maven commandline > documentation, and it sounds like you would probably agree. [Johan Iskandar] Perldoc? Emmm, does this have to do anything with perl..? Sorry I don't do perl..i think I have enough things to deal with.. otherwise I might lose my hair..:P So, I'll stick to java.. > > Ideally we'd find a way for the plugin documentation (which currently > creates the plugin websites) to somehow also function as the basis for > this "mvn help xyz" function. Then we've got 1 source of documentation > and we can generate multiple views (website, help plugin, etc) on the > docs. > [Johan Iskandar] Yes, that would centralize many things and would reuse many of the already available documentation on those plugins.. There's one thing more I'd like to note.. Ideally the help function could always get updated (in case of bugs, updates, etc), but what happens if the maven encountered error while/after downloading the help function..? Then the user doesn't have a hint on how to get a hint..:P So, the working maven build (bundle) should inherently at least be informative enough about how to get the help function in case an unexpected events should happen.. > I don't know who (if anyone) is pursuing this idea currently, but I > agree that it sounds like a reasonable approach to take in an effort > to improve documentation. [Johan Iskandar] I'd like to help...but not possible in these months to follow.. All I can do right now is pour my thoughts about maven.. I'm currently trying to push maven's process to my colleagues way of thinking.. I'm sure they'll eventually buy it.. > > Wayne Regards, Johan --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
