I've already got a start at a more comprehensive set of documentation for the assembly plugin on localhost. I'll try to flesh it out today and get it committed...it shouldn't take more than a day to document a plugin, even one as complex as the assembly plugin.
-john On 5/8/06, Brett Porter <[EMAIL PROTECTED]> wrote:
Mike Perham wrote: > Brett, I appreciate the concern on the subject. > > My main concern is not thorough documentation - it's basic "what is this > and what is it for" doucmentation. Adding goals to a plugin but not > including basic user documentation just perpetrates Maven's reputation > as a poorly documented project. There needs to be a basic quality level > for documentation which is enforced. In the case of plugins, I consider > the minimum to be common examples and usecases for the goals within the > plugin. A plugin and its goals are useless if a user cannot determine > how to use them to solve his problems. Agreed. John, can you do this for the Assembly plugin? > > I've seen some amazing progress on testing in the last few weeks. > Perhaps a similar effort in the next two months around documentation > would lead to similar results. ++1 > > At any rate, I think releasing the plugins ASAP is important. I can't > spend a lot of time on the bleeding SVN edge but once they are released > I can start contributing to the documentation myself. > Awesome. I'll start a laundry list of things and we can keep adding to that over the coming weeks while we get started. Thanks! - Brett --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
