You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Rapha?l Pi?roni (JIRA)" <ji...@codehaus.org> on 2006/03/10 18:17:23 UTC
[jira] Created: (MNG-2143) Proposition of documentation
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
[jira] Updated: (MNG-2143) Proposition of documentation
Posted by "John Casey (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=all ]
John Casey updated MNG-2143:
----------------------------
Fix Version: (was: documentation)
2.0.5
> 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
> Fix For: 2.0.5
> Attachments: AdvancedDocumentation.apt, Categories.txt, 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
[jira] Updated: (MNG-2143) Proposition of documentation
Posted by "John Casey (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=all ]
John Casey updated MNG-2143:
----------------------------
Fix Version: documentation
> 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
> Fix For: documentation
> Attachments: AdvancedDocumentation.apt, Categories.txt, 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
[jira] Updated: (MNG-2143) Proposition of documentation
Posted by "Kenney Westerhof (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=all ]
Kenney Westerhof updated MNG-2143:
----------------------------------
Fix Version/s: (was: 2.0.5)
2.0.6
> Proposition of documentation
> ----------------------------
>
> Key: MNG-2143
> URL: http://jira.codehaus.org/browse/MNG-2143
> Project: Maven 2
> Issue Type: Improvement
> Components: Documentation: General
> Reporter: Raphaël Piéroni
> Fix For: 2.0.6
>
> Attachments: AdvancedDocumentation.apt, Categories.txt, 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
[jira] Commented: (MNG-2143) Proposition of documentation
Posted by "Rapha?l Pi?roni (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=comments#action_60685 ]
Raphaël Piéroni commented on MNG-2143:
--------------------------------------
I think the first part of the refactor task should be to find the categories.
Here are the categories i saw:
Archetypes
Testing
This category includes unit testing and integration testing
Maven tools
For talking about the other programs like the ant tasts and the repository manager
Maven extension development
For creating plugins and archetypes
Generating sources
Site
This is for the project developer site with sub categories
Quality for reports like PMD, checkstyle, surefire, ...
Documentation for reports like javadoc, jxr, ...
Information for reports like mailing list, issue trasker, ...
Ide
For using maven in an ide
Deployments
For deploying artifacts into repositories, application servers
Associated artifacts
For creating and attaching some associated artifacts like sources, javadoc, ...
Packagings
For talking about alternative packagings like war, ear, ...
Alternative languages
For using maven with other languages like c#, aspecjt, ...
Continuous integration
For using maven with a continuous integration system
Then we should put guides and plugins into the categories.
Some plugins may belong into more than one category.
We also need some basic documentation for talking about
theorical concepts like packagings, repositories, ...
Then write the site...
> 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
[jira] Closed: (MNG-2143) Proposition of documentation
Posted by "Vincent Siveton (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Vincent Siveton closed MNG-2143.
--------------------------------
Assignee: Vincent Siveton
Resolution: Won't Fix
seems to be out of date
> Proposition of documentation
> ----------------------------
>
> Key: MNG-2143
> URL: http://jira.codehaus.org/browse/MNG-2143
> Project: Maven 2
> Issue Type: Improvement
> Components: Documentation: General
> Reporter: Raphaël Piéroni
> Assignee: Vincent Siveton
> Fix For: Documentation Deficit
>
> Attachments: AdvancedDocumentation.apt, Categories.txt, 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
[jira] Updated: (MNG-2143) Proposition of documentation
Posted by "Rapha?l Pi?roni (JIRA)" <ji...@codehaus.org>.
[ http://jira.codehaus.org/browse/MNG-2143?page=all ]
Raphaël Piéroni updated MNG-2143:
---------------------------------
Attachment: Categories.txt
> 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, Categories.txt, 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
[jira] Commented: (MNG-2143) Proposition of documentation
Posted by "Rapha?l Pi?roni (JIRA)" <ji...@codehaus.org>.
[ 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