maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Rapha?l Pi?roni (JIRA)" <j...@codehaus.org>
Subject [jira] Commented: (MNG-2143) Proposition of documentation
Date Fri, 10 Mar 2006 17:43:23 GMT
    [ http://jira.codehaus.org/browse/MNG-2143?page=comments#action_60686 ] 

Raphaël Piéroni commented on MNG-2143:
--------------------------------------

I copy an extract of the initial proposition from my post in the dev list:

So here is a cleaner proposition for the site.
This proposition is focused on the documentation for the user.

I assume the user is a java developer but may not be a maven developer.
What do a developer (and maven user) want to know:
- where to find the software,
- how to install it,
- how to configure maven use in a proper environment,
- how to configure it's project,
- how to run maven and get it project properly packaged.

Therefore i propose the following presentation of the maven site.
Reading Convention: _a_ is a link to "a", (text) is a comment, <text> is
a variable
Main page :
<Title missing>
_what is maven ?_
_download_
_installation_
_getting started_

Maven Concepts
_introduction_
_project descriptor_
_artifact_
_life cycle_
_repositories_
_plugins_
_directory convention_
_archetypes_

Normative References
_Project Object Model_
_User Settings_

[SNIP]

End of page


> Proposition of documentation
> ----------------------------
>
>          Key: MNG-2143
>          URL: http://jira.codehaus.org/browse/MNG-2143
>      Project: Maven 2
>         Type: Improvement

>   Components: Documentation:  General
>     Reporter: Raphaël Piéroni
>  Attachments: AdvancedDocumentation.apt, MainPage.apt
>
>
> Here attached are 2 apt file that describe a first attempt to refactor the maven documentation
site.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


Mime
View raw message