You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2005/10/18 23:48:08 UTC
svn commit: r326261 - in /maven/components/trunk/maven-site/src/site:
apt/documentation-required.apt
apt/guides/introduction/introduction-to-plugins.apt xdoc/index.xml
Author: jvanzyl
Date: Tue Oct 18 14:48:05 2005
New Revision: 326261
URL: http://svn.apache.org/viewcvs?rev=326261&view=rev
Log: (empty)
Added:
maven/components/trunk/maven-site/src/site/apt/documentation-required.apt (with props)
Modified:
maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-plugins.apt
maven/components/trunk/maven-site/src/site/xdoc/index.xml
Added: maven/components/trunk/maven-site/src/site/apt/documentation-required.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/documentation-required.apt?rev=326261&view=auto
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/documentation-required.apt (added)
+++ maven/components/trunk/maven-site/src/site/apt/documentation-required.apt Tue Oct 18 14:48:05 2005
@@ -0,0 +1,82 @@
+ -----
+ Documentation Required
+ -----
+ Jason van Zyl
+ -----
+ 12 October 2005
+ -----
+
+Documentation Required
+
+ 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 {{{/mail-lists.html}>Maven Users Mailing List}}.
+
+* Documentation for users
+
+ * New SNAPSHOT handling
+
+ * Guide to dependencies, including:
+
+ * Dependency scoping - <especially system scope>
+
+ * Version range specifications
+
+ * Conflict resolution>
+
+ * Deployment mechanism
+
+ * Dependency management
+
+ * Plugin management - <in progress by J Matthew Pryor and John Casey>
+
+ * Plugin configuration
+
+ * Plugin downloading
+
+ * Report generation
+
+ * Project inheritence and company wide strategy
+
+ * Plugin documentation
+
+ * Using POM-properties in conjunction with plugin configuration to abstract child-POM configs
+
+ * Archetypes - writing and using
+
+ * Plugin usage guide/summary for core plugins - <esp. release plugin</i>
+
+ * Strategy for migrating from Ant builds
+
+ * Strategy for migrating from Maven 1.x builds - <esp. plugins that don't convert directly>
+
+ []
+
+* Documentation for plugin authors
+
+ * Beanshell examples
+
+ * Plugin writing guide
+
+ * Report writing guide
+
+ * Site customisation guide
+
+ * Common tips and tricks for accessing project/build data
+
+ * Guide to available parameter expressions
+
+ * List of standards for submitting new plugins (minimum documentation, test coverage?)
+
+ []
+
+* Documentation for Maven developers
+
+ * Lifecycle architecture</li>
+
+ * High level architecture, components explanation</li>
+
+ * Intro to Plexus</li>
+
+ * Contributors guide (add to current and consolidate, walk through some first steps)
+
+[]
Propchange: maven/components/trunk/maven-site/src/site/apt/documentation-required.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/components/trunk/maven-site/src/site/apt/documentation-required.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-plugins.apt
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-plugins.apt?rev=326261&r1=326260&r2=326261&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-plugins.apt (original)
+++ maven/components/trunk/maven-site/src/site/apt/guides/introduction/introduction-to-plugins.apt Tue Oct 18 14:48:05 2005
@@ -26,7 +26,7 @@
capabilities and build-process management, and a host of plugins which are
used to execute the actual build tasks.
-** What is a Plugin?
+* What is a Plugin?
"Maven" is really just a core framework for a collection of
Maven Plugins. In other words, plugins are where much of the real action is
@@ -52,7 +52,7 @@
a parameter}} which can be used to customize plugin behavior, this parameter is
called outputDirectory and it defaults to ${project.build.directory}.
-** What is a Mojo (<And Why the H--- is it Named 'Mojo'>)?
+* What is a Mojo (<And Why the H--- is it Named 'Mojo'>)?
A Mojo is really just a goal in Maven 2, and plug-ins consist of
any number of goals (Mojos). Mojos can be defined as annotated Java classes or
@@ -67,13 +67,13 @@
Such bags were thought to have supernatural powers, such as protecting from evil,
bringing good luck, etc."
-** What is the Build Lifecycle? (Overview)
+* What is the Build Lifecycle? (Overview)
The build lifecycle is a series of common stages through which all project
builds naturally progress. Plugin goals are bound to specific stages in the
lifecycle.
-* Resources
+Resources
[[1]] {{{developers/plugin-development-guide.html}Plugin development guide}}
@@ -82,9 +82,9 @@
[[3]] {{{getting-started.html#configuring_plugins}Configuring plugins}}
-* Comparison to Maven 1.x Plugins
+Comparison to Maven 1.x Plugins
-** Similarities to Maven 1.x
+* Similarities to Maven 1.x
Maven 2.0 is similar to its predecessor in that it has two main
functions. First, it organizes project data into a coherent whole,
@@ -110,7 +110,7 @@
As such, it has a much different and more evolved architecture - at least to
our minds. <<;-)>>
-** Differences from Maven 1.x
+* Differences from Maven 1.x
However similar the architectures may seem, Maven 2 offers a much
richer environment for its plugins than Maven 1 ever did. The new
@@ -157,7 +157,7 @@
multi-project build process into the maven core conceptual
framework.
-** Why Change the Plugin Architecture?
+* Why Change the Plugin Architecture?
See the previous section for the long version, but the short version can
be summed up by the following list of benefits.
Modified: maven/components/trunk/maven-site/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-site/src/site/xdoc/index.xml?rev=326261&r1=326260&r2=326261&view=diff
==============================================================================
--- maven/components/trunk/maven-site/src/site/xdoc/index.xml (original)
+++ maven/components/trunk/maven-site/src/site/xdoc/index.xml Tue Oct 18 14:48:05 2005
@@ -37,7 +37,7 @@
<h4>Maven 2.x Documentation</h4>
</p>
<p>
- All the Maven documentation for Maven 2.x is in the form of guides
+ All the 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>