Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

o trying to make the documentation more apparent 

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@326251 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Jason van Zyl 2005-10-18 21:23:07 +00:00
parent 925b341c17
commit 928edc8f00
2 changed files with 7 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
maven-site/src/site/xdoc/docs-required.xml
View File

@ -1,64 +0,0 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Documentation Required</title>
<author email="brett@apache.org">Brett Porter</author>
</properties>
<body>
<section name="Documentation Required">
<p>
This page lists some of the most pressing documentation needs. If you feel something is missing, please be sure
to let us know at the
<a href="/mail-lists.html">Maven Users Mailing List</a>.
</p>
<h4>Documentation for users</h4>
<ul>
<li>new SNAPSHOT handling -
<i>partially done on Brett's blog</i>
</li>
<li>guide to dependencies, including:
<ul>
<li>dependency scoping - <i>especially system scope</i></li>
<li>version range specifications</li>
<li>conflict resolution</li>
</ul>
</li>
<li>deployment mechanism</li>
<li>dependency management</li>
<li>plugin management -
<i>in progress by J Matthew Pryor and John Casey</i>
</li>
<li>plugin configuration</li>
<li>plugin downloading -
<i>partial on Brett's blogs</i>
</li>
<li>report generation</li>
<li>project inheritence and company wide strategy</li>
<li>plugin documentation</li>
<li>using POM-properties in conjunction with plugin configuration to abstract child-POM configs</li>
<li>archetypes - writing and using</li>
<li>plugin usage guide/summary for core plugins - <i>esp. release plugin</i></li>
<li>strategy for migrating from Ant builds</li>
<li>strategy for migrating from Maven 1.x builds - <i>esp. plugins that don't convert directly</i></li>
</ul>
<h4>Documentation for plugin authors</h4>
<ul>
<li>Beanshell examples</li>
<li>plugin writing guide</li>
<li>report writing guide</li>
<li>site customisation guide</li>
<li>common tips and tricks for accessing project/build data</li>
<li>guide to available parameter expressions</li>
<li>list of standards for submitting new plugins (minimum documentation, test coverage?)</li>
</ul>
<h4>Documentation for Maven developers</h4>
<ul>
<li>Lifecycle architecture</li>
<li>High level architecture, components explanation</li>
<li>Intro to Plexus</li>
<li>contributors guide (add to current and consolidate, walk through some first steps)</li>
</ul>
</section>
</body>
</document>

7
maven-site/src/site/xdoc/index.xml
View File

@ -33,6 +33,13 @@
Maven is a software project management and comprehension tool. Based on the concept of a project object model Maven is a software project management and comprehension tool. Based on the concept of a project object model
(POM), Maven can manage a project's build, reporting and documentation from a central piece of information. (POM), Maven can manage a project's build, reporting and documentation from a central piece of information.
</p> </p>
<p>
<h4>Maven 2.x Documentation</h4>
</p>
<p>
All the Maven documentation for Maven 2.x is in the form of guides
which can all be found <a href="http://people.apache.org/~jvanzyl/maven2/guides/index.html">here</a>.
</p>
<p> <p>
<h4>About Maven 2.0</h4> <h4>About Maven 2.0</h4>
</p> </p>