On 11/6/06, Brett Porter <[EMAIL PROTECTED]> wrote:
On 07/11/2006, at 3:33 PM, Wendy Smoak wrote: > On 11/6/06, Franz Allan Valencia See <[EMAIL PROTECTED]> wrote: > >> I don't think the new plugin docus can be published yet until the >> plugins themselves are released. Those docus were based on the >> snapshot versions and some information they contain may not be >> applicable to the currently released versions. > > As I understand it, a 'since' attribute was introduced so that we can > identify the version in which new features will appear. That means we > can go ahead and publish now, users will understand that if they're > using 1.1.3, something marked 'since 1.1.4' will not exist. This does depend on people marking that up. I think at this point we are better off correcting the issues of not marking it up than missing the docs that are there.
I'm willing to contribute again to the plugin docs but just a few clarifications: So the priority now for the maven plugins docs is to mark them up with @since tags? If im not mistaken, most (if not all) of those docs do not have the since tags. And if we're going to apply those @since tags to just the mojos, goals, and javadocs. What about the usage and examples? Also, maybe the @since tags should be documented as well in [1]?
> > Waiting until the next release to publish docs isn't working. There's > too much good stuff sitting in svn, invisible, and it does nothing to > encourage contributions since it may be weeks or months before you > ever see your work "in print". Agreed.
True, but I guess we need those @since tags first...or in the meantime, at least a note at their intro pages stating something like "This doc was intended for the current snapshot version and may not be applicable to the currently released version. For more information...." And speaking of getting the users involved, maybe a visible feedback page, or a link to the "how to contirbute" page would be nice, and maybe even a link to that plugin's wiki page so that users can share their info such as cookbook recipes :-) (which can later be incorporated in the docs) WDYT? Cheers, Franz [1] http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
