On 11/16/06, Adam Hardy <[EMAIL PROTECTED]://mail.google.com/mail/> wrote:
Just wanted to dredge up this old thread concerning documentation to find out what status it has now after the last conversation.
I think this was already in the works when this thread started, but the plugins and guides are now organized by category instead of just a long list, and the index page and main site menu have been reworked. For example: http://maven.apache.org/guides/index.html http://maven.apache.org/plugins/index.html Then we decided that the benefit of publishing up-to-date plugin sites outweighs the possible confusion caused by as-yet-unreleased features showing up, and all but one or two of the plugin sites have been published.
I had problems today finding some documentation on the war plugin. Pretty standard stuff but I couldn't even find the plugins documentation start page in the left-hand menu, rather I found it on the home page (where I happened NOT to be to start with) in the text. I think this is a symptom of the extensive nature of the maven docs, but still it's pretty fundamental.
The left hand menu says "Get Maven Plugins -> By Category". I've seen at least one other comment about it, and this week I had a new person at work also not find it when told, "Click on the 'get plugins' link on the menu." I think we're scanning the leftmost text, and not ever finding the word "plugin". Unless someone has another suggestion, I'm going to try "Plugins by Category".
Secondly the comments functionality or the link to the wiki is a pretty urgent requirement for me, and I think I'm a typical user.
Where are you looking to add comments? Honestly I don't think we're going to get a 'comment mechanism' on the existing site. It's static html generated from apt and other sources. However, getting plugin site -> wiki links is next on my list. Any thoughts on what a menu link on each plugin site might be called? For example, I'm planning to link Maven Javadoc Plugin http://maven.apache.org/plugins/maven-javadoc-plugin to its wiki page http://docs.codehaus.org/display/MAVENUSER/Javadoc+Plugin Just "Wiki" seems insufficient (especially since there's already a "Wiki" link on the main Maven site that points to the top of the MAVENUSER space.) The wiki still needs some organization, especially to make it easy to add new pages. The longer someone is unsure of what to click, the higher the probability that they'll just go away without contributing. Here's an interesting new contribution, a howto with screen shots of setting up Maven, Continuum and Archiva in a corporate environment: http://docs.codehaus.org/display/MAVENUSER/MavenProjectServer Someone on IRC mentioned writing a 'wikibook' (an open-content textbook) on Maven. There were several other suggestions that I haven't yet had time to sort through. Thanks for bringing it up again! More comments and discussion are welcome... -- Wendy --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
