On 07/11/2006, at 4:50 PM, Franz Allan Valencia See wrote:
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.
It should only be necessary as new features are added.
And if we're going to apply those @since tags to just the mojos, goals, and javadocs. What about the usage and examples?
That's going to need to be explained inline where needed.
Also, maybe the @since tags should be documented as well in [1]?
Yes, but isn't this also included in the Maven site somewhere?
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...."
I think the addition of new documentation outweighs the problems we'll see from snapshot features, but we should mark them up as we seem them.
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)
I think these are a good idea, but I'd look to set this up in a structured fashion rather than manually adding it to every plugin if we can.
- Brett --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
