Cool. I think this is a good idea.

In my original proposal:
"* The documentation is a big list of links. I think we should categorise
them by topic instead of type, or perhaps as Jesse suggests we should
have a cross reference/index - so we could have a page that lists all
the howtos and guides, then another that lists the docs related to
artifacts, plugins, etc."

These seem like good starts at the type of alternate indices I was
thinking of. Would you mind capturing these in a JIRA item?

- Brett

Piéroni Raphaël wrote:
> It aims to be a page or a couple of pages.
> 
> I don't have clear idea on it.
> 
> yesterday i wrote it in two pages : a main page with sample doco and an
> advanced page with an exhautive doco (not in my sample be should be)
> 
> But i think it is not a navigation.
> 
> Raphaël
> 
> 2006/3/10, Brett Porter <[EMAIL PROTECTED]>:
>> Thanks for attempting this.
>>
>> IS this intended to be a navigation, a page, a series of pages? I'm a
>> little confused.
>>
>> Do you have any feedback on my original proposal on this thread? It
>> tried to examine many of the same problems.
>>
>> - Brett
>>
>> Raphaël Piéroni wrote:
>>> Hi,
>>>
>>> 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_
>>>
>>> Basic Documentation (in the project life cycle order and in multi
>> column)
>>>  Archetypes
>>>    Guides
>>>      _using a project archetype_
>>>      _creating an archetype_
>>>    Plugins
>>>      _archetype plugin_
>>>    Archetypes
>>>      _quickstart_
>>>      _webapp_
>>>
>>>  Generating Sources
>>>    Guides
>>>      _<no idea>_
>>>   Plugins
>>>      _xdoclet_
>>>      _antlr_
>>>      _modello_
>>>
>>>  Testing
>>>    Guides
>>>      _unit testing_
>>>      _integration testing_
>>>      _plugin testing_ (move to advanced documentation ?)
>>>    Plugins
>>>      _surefire_
>>>      _cargo_
>>>
>>>  Deployment
>>>    Guides
>>>      _creating an enterprise repository_
>>>    Plugins
>>>       _deploy_
>>>       _tomcat_
>>>
>>>  Site
>>>    Guides
>>>      _creating a maven site_
>>>      _using reports_
>>>    Plugins
>>>      _site_
>>>      _changes_
>>>    Reports
>>>      _cobertura_
>>>      _javadoc_
>>>      _changelog_
>>>      _checkstyle_
>>>
>>> Advanced Documentation (in the project life cycle order and in multi
>>> column)
>>>  Maven in an Ide
>>>    Guides
>>>      _using maven in IDEA_
>>>    Plugins
>>>      _eclipse_
>>>   Ide extensions
>>>      _mevenide2_
>>>
>>>  Plugin Development Documentation
>>>    Guides
>>>      _creating a Plugin in Java_
>>>      _creating a Plugin using Ant_
>>>    Plugins
>>>      _plugin_
>>>    Reports
>>>      _mojo description_
>>>
>>>  Packagings
>>>    Guides
>>>      _creating webapps_
>>>      _creating desktop applications_
>>>    Plugins
>>>      _war_
>>>      _ejb_
>>>
>>>  Associated Artifacts
>>>    Guides
>>>      _deploying the sources along with the main artifact_
>>>      _using an assembly_
>>>    Plugins
>>>      _source_
>>>      _assembly_
>>>
>>>  Misc.
>>>    Guide
>>>      _filtering resources_
>>>
>>> End of page
>>>
>>> For a better use of the development process, do this proposition must
>>> belong to a wiki page or in the mailing list it is correct ?
>>>
>>> Regards,
>>>
>>> Raphaël
>>>
>>>
>>>
>>> ---------------------------------------------------------------------
>>> 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]
>>
>>

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to