The "Documentation Check" (DOCCK) plugin was recently created to help address this very issue. It will help not only Maven but also its plugins and even other projects/plugins using Maven.
Maven Dev has established a baseline for expected documentation and will now use this plugin to enforce that baseline for all plugins etc. This doesn't help much if other Plugin sites (ie Codehaus) don't adopt the plugin into their process too, or if you're looking to use a random plugin created and hosted entirely independent of Maven, but it should help alleviate this issue for many plugins. Wayne On 10/31/06, Wendy Smoak <[EMAIL PROTECTED]> wrote:
On 10/31/06, Sebastien Arbogast <[EMAIL PROTECTED]> wrote: > Think of Hibernate or PHP documentation: one base reference book with > DYNAMIC comments in which people can share their thoughts and > experiences about each feature/chapter, remarks that can be later > integrated when the reference is rewritten. The problem is that, > whereas development itself is a highly-collaborative and efficient > process, nothing is really done so that documentation writing is > collaborative enough: no workflow, no direct input, no dynamic > comments, etc. Many of the plugins have improved docs that haven't been published yet. That's on my list for this weekend, determining whether it's okay to publish them, or whether we need to establish a separate area for the latest-and-greatest docs that may not match the released version. What I'd like to do for comments is make use of the MAVENUSER wiki [1]. I'd like to see a link on every plugin site so that users can share configuration examples or tell us that something is just plain wrong. What do you think? Any ideas on how to present that as an option? What would the menu link be called? How should the pages on the wiki be organized? (The Better Builds book belongs to Mergere, so they would have to agree to any changes in the way it is produced.) [1] http://docs.codehaus.org/display/MAVENUSER/Home -- Wendy --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
