mirror of https://github.com/apache/maven.git
bunch of site updates for alpha-2
git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@170033 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Brett Leslie Porter
parent
724b057ad2
commit
ab0012f249
|
|
@ -0,0 +1,48 @@
|
|||
------
|
||||
Release Notes - Maven 2.0 Alpha 2
|
||||
------
|
||||
Brett Porter
|
||||
------
|
||||
13 May 2005
|
||||
------
|
||||
|
||||
The Apache Maven team are proud to announce the second alpha release of Maven 2.0.
|
||||
|
||||
Download it from {{http://maven.apache.org/maven2/download.html}}
|
||||
|
||||
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.
|
||||
|
||||
This release includes <<{{{http://jira.codehaus.org/secure/IssueNavigator.jspa?reset=true&pid=10500&fixfor=11020} 76 bug fixes and enhancements}}>> since the
|
||||
first release on 8 April.
|
||||
|
||||
Maven 2.0 is a rewrite of the popular Maven application to achieve a number of goals, and to provide a stable
|
||||
basis to take it into the future. While it can be considered quite stable, and future versions are now expected to
|
||||
retain a high amount of backwards compatibility, this is still a technology preview, and not yet complete or
|
||||
considered ready for a production environment.
|
||||
|
||||
The main new features in this release are:
|
||||
|
||||
* Basic site generation
|
||||
|
||||
* Improved error handling
|
||||
|
||||
* Automatic plugin updates
|
||||
|
||||
* Published Mojo and Plugin API
|
||||
|
||||
* Inclusion of Ant tasks for Maven 2.0
|
||||
|
||||
This release is expected to be much more architecturally stable, making early adoption
|
||||
a possiblity. At this point, there are still only the core plugins available.
|
||||
|
||||
We hope you enjoy using Maven! If you have any questions, please consult:
|
||||
|
||||
* the web site: {{http://maven.apache.org/maven2/}}
|
||||
|
||||
* the maven-user mailing list: {{http://maven.apache.org/mail-lists.html}}
|
||||
|
||||
For news and information, see:
|
||||
|
||||
* Maven Blogs: {{http://www.mavenblogs.com/}}
|
||||
|
||||
|
|
@ -0,0 +1,141 @@
|
|||
------
|
||||
Generating a Site
|
||||
------
|
||||
Brett Porter
|
||||
------
|
||||
13 May 2005
|
||||
------
|
||||
|
||||
Building a Site
|
||||
|
||||
* Creating Content
|
||||
|
||||
The first step to creating your site is to create some content. In Maven 2.0, the site content is separated by format,
|
||||
as there are several available.
|
||||
|
||||
-------------------
|
||||
+- src/
|
||||
+- site/
|
||||
+- apt/
|
||||
| +- index.apt
|
||||
|
|
||||
+- xdoc/
|
||||
| +- other.xml
|
||||
|
|
||||
+- fml/
|
||||
| +- general.fml
|
||||
| +- faq.fml
|
||||
|
|
||||
+- site.xml
|
||||
--------------------
|
||||
|
||||
The Xdoc format is the same as {{{http://maven.apache.org/using/site.html} used in Maven 1.0}}. However, <<<navigation.xml>>>
|
||||
has been replaced by the site descriptor (see below).
|
||||
|
||||
The APT format, "Almost Plain Text", is a wiki-like format that allows you to write simple, structured documents (like this)
|
||||
very quickly. A full reference of the {{{http://www.xmlmind.com/_aptconvert/docs/userguide2.html#id.s2} APT Format}} is available.
|
||||
|
||||
The FML format is the FAQ format, also used in Maven 1.0.
|
||||
|
||||
Other formats are available, but at this point these 3 are the best tested. There are also several possible output formats,
|
||||
but as of alpha-2, only XHTML is available.
|
||||
|
||||
Note that all of the above is optional - just one index file is required in one of the input trees. Each of the paths will be merged
|
||||
together to form the root directory of the site.
|
||||
|
||||
* Generating The Site
|
||||
|
||||
Generating the site is very simple, and fast!
|
||||
|
||||
---------------
|
||||
m2 site:site
|
||||
---------------
|
||||
|
||||
The resulting site will be in <<<target/site/...>>>
|
||||
|
||||
For more information on the site plugin, see the {{{plugins/maven-site-plugin/} plugin reference}}.
|
||||
|
||||
* Deploying The Site
|
||||
|
||||
To be able to deploy the site, you must first declare a location to distribute to in your <<<pom.xml>>>, similar to the repository for
|
||||
deployment.
|
||||
|
||||
---------------
|
||||
<distributionManagement>
|
||||
<site>
|
||||
<id>website</id>
|
||||
<url>scp://www.mycompany.com/www/docs/project/</url>
|
||||
</site>
|
||||
</distributionManagement>
|
||||
---------------
|
||||
|
||||
The <<<id>>> element identifies the repository, so that you can attach credentials to it in your <<<settings.xml>>>
|
||||
file in the same way as you would for any other repository. The URL gives the location to deploy to. Currently,
|
||||
only SSH is supported, as above which copies to the host <<<www.mycompany.com>>> in the path <<</www/docs/project/>>>.
|
||||
|
||||
Deploying the site is done with the <<<site:deploy>>> goal. Note that you cannot just call the deployment goal on its own, however.
|
||||
You must presently run the <<<site:site>>> goal independantly.
|
||||
|
||||
---------------
|
||||
m2 site:site site:deploy
|
||||
---------------
|
||||
|
||||
<<Note:>> the trailing slash in the URL above indicates that any subprojects that inherit this value should append their artifact ID to
|
||||
the path instead of using it as is.
|
||||
|
||||
* Creating a Site Descriptor
|
||||
|
||||
The <<<site.xml>>> file is used to describe the layout of the site, and replaces the navigation file used in Maven 1.0.
|
||||
|
||||
A sample is given below:
|
||||
|
||||
--------------------
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<project name="Maven">
|
||||
<bannerLeft>
|
||||
<name>Maven</name>
|
||||
<src>http://maven.apache.org/images/apache-maven-project.png</src>
|
||||
<href>http://maven.apache.org/</href>
|
||||
</bannerLeft>
|
||||
<bannerRight>
|
||||
<src>http://maven.apache.org/images/maven-small.gif</src>
|
||||
</bannerRight>
|
||||
<body>
|
||||
<links>
|
||||
<item name="Apache" href="http://www.apache.org/" />
|
||||
<item name="Maven 1.0" href="http://maven.apache.org/"/>
|
||||
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
|
||||
</links>
|
||||
|
||||
<menu name="Maven 2.0">
|
||||
<item name="Introduction" href="index.html"/>
|
||||
<item name="Download" href="download.html"/>
|
||||
<item name="Release Notes" href="release-notes.html" />
|
||||
<item name="General Information" href="about.html"/>
|
||||
<item name="For Maven 1.0 Users" href="maven1.html"/>
|
||||
<item name="Road Map" href="roadmap.html" />
|
||||
</menu>
|
||||
...
|
||||
</body>
|
||||
</project>
|
||||
--------------------
|
||||
|
||||
~~TODO: deserves more explanation.
|
||||
|
||||
* Adding Additional Resources
|
||||
|
||||
You can also add images and CSS to your site, by creating the following directories in your site sources:
|
||||
|
||||
-------------------
|
||||
+- src/
|
||||
+- site/
|
||||
+- css/
|
||||
| +- site.css
|
||||
|
|
||||
+- images/
|
||||
| +- pic1.jpg
|
||||
|
|
||||
--------------------
|
||||
|
||||
The file <<<site.css>>> will be added to the default XHTML output, so can be used to adjust the default Maven stylesheets if desired.
|
||||
|
||||
|
|
@ -18,6 +18,7 @@
|
|||
<menu name="Maven 2.0">
|
||||
<item name="Introduction" href="index.html"/>
|
||||
<item name="Download" href="download.html"/>
|
||||
<item name="Release Notes" href="release-notes.html" />
|
||||
<item name="General Information" href="about.html"/>
|
||||
<item name="For Maven 1.0 Users" href="maven1.html"/>
|
||||
<item name="Road Map" href="roadmap.html" />
|
||||
|
|
@ -28,12 +29,13 @@
|
|||
<item name="Dependency Mechanism" href="dependencies.html"/>
|
||||
<item name="Developing Plugins" href="developers/plugin-overview.html"/>
|
||||
<item name="Developing Plugins with Marmalade" href="developers/developing-plugins-with-marmalade.html"/>
|
||||
<item name="Creating a Site" href="site.html"/>
|
||||
</menu>
|
||||
<menu name="Reference">
|
||||
<item name="Project Descriptor" href="project-descriptor.html"/>
|
||||
<item name="Settings Descriptor" href="settings-descriptor.html"/>
|
||||
<item name="Available Plugins" href="plugin-list.html"/>
|
||||
<item name="Mojo API" href="developers/mojo-specification-api.html" />
|
||||
<item name="Project Descriptor" href="maven-model/maven.html"/>
|
||||
<item name="Settings Descriptor" href="maven-settings/settings.html"/>
|
||||
<item name="Available Plugins" href="plugins/index.html"/>
|
||||
<item name="Mojo API" href="developers/mojo-api-specification.html" />
|
||||
<item name="Ant Tasks" href="ant-tasks.html"/>
|
||||
</menu>
|
||||
<menu name="Developers">
|
||||
|
|
|
|||
|
|
@ -35,13 +35,11 @@
|
|||
</p>
|
||||
<p>
|
||||
You can specify your user configuration in <code>${user.home}/.m2/settings.xml</code>. A
|
||||
<a href="settings-descriptor.html">full reference</a> to the
|
||||
<a href="maven-settings/settings.html">full reference</a> to the
|
||||
configuration file is available. This section will show how to make some common configurations.
|
||||
Note that the file is not required - defaults will be used if it is not found.
|
||||
</p>
|
||||
<p style="font-weight: bold; font-size: larger">
|
||||
Configuring your Local Repository
|
||||
</p>
|
||||
<h4>Configuring your Local Repository</h4>
|
||||
<p>
|
||||
The local repository is part of a profile in your user configuration. You can have multiple profiles, with one
|
||||
set to active so that you can switch environments.
|
||||
|
|
@ -61,9 +59,7 @@
|
|||
<p>
|
||||
The local repository must be an absolute path.
|
||||
</p>
|
||||
<p style="font-weight: bold; font-size: larger">
|
||||
Configuring a Proxy
|
||||
</p>
|
||||
<h4>Configuring a Proxy</h4>
|
||||
<p>
|
||||
You can configure a proxy to use for some or all of your HTTP requests in Maven 2.0. The username and
|
||||
password are only required if your proxy requires basic authentication (note that later alphas will support
|
||||
|
|
|
|||
|
|
@ -458,7 +458,7 @@
|
|||
rather than plugin configurations, as in the case where you want
|
||||
to use the artifact's final name as a parameter. In this case,
|
||||
you want the user to modify
|
||||
<build><finalName/></build> rather than
|
||||
<build><finalName/></build> rather than
|
||||
specifying a value for finalName directly in the plugin
|
||||
configuration section. It is also useful to ensure that - for
|
||||
example - a List-typed parameter which expects items of type
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@
|
|||
to let us know at the
|
||||
<a href="/mail-lists.html">Maven Users Mailing List</a>.
|
||||
</p>
|
||||
<p style="font-size: larger; font-weight: bold">Documentation for users</p>
|
||||
<h4>Documentation for users</h4>
|
||||
<ul>
|
||||
<li>new SNAPSHOT handling -
|
||||
<i>partially done on Brett's blog</i>
|
||||
|
|
@ -19,15 +19,19 @@
|
|||
<li>deployment mechanism</li>
|
||||
<li>build lifecycle documentation</li>
|
||||
<li>dependency management</li>
|
||||
<li>plugin management</li>
|
||||
<li>plugin management - <i>in progress by J Matthew Pryor and John Casey</i></li>
|
||||
<li>plugin configuration</li>
|
||||
<li>plugin downloading</li>
|
||||
<li>plugin downloading - <i>partial on Brett's blogs</i></li>
|
||||
<li>site generation</li>
|
||||
<li>report generation</li>
|
||||
</ul>
|
||||
<p style="font-size: larger; font-weight: bold">Documentation for plugin authors</p>
|
||||
<h4>Documentation for plugin authors</h4>
|
||||
<ul>
|
||||
<li>plugin writing guide</li>
|
||||
<li>report writing guide</li>
|
||||
<li>site customisation guide</li>
|
||||
</ul>
|
||||
<p style="font-size: larger; font-weight: bold">Documentation for Maven developers</p>
|
||||
<h4>Documentation for Maven developers</h4>
|
||||
<ul>
|
||||
<li>Lifecycle architecture</li>
|
||||
<li>High level architecture, components explanation</li>
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@
|
|||
</project>]]></source>
|
||||
<p>
|
||||
You can get a full reference to the
|
||||
<a href="project-descriptor.html">project descriptor</a> to see what other
|
||||
<a href="maven-model/maven.html">project descriptor</a> to see what other
|
||||
elements are available.
|
||||
</p>
|
||||
<p>
|
||||
|
|
|
|||
|
|
@ -1,33 +0,0 @@
|
|||
<project>
|
||||
<title>Maven 2</title>
|
||||
|
||||
<body>
|
||||
<links>
|
||||
<item name="Maven 1.0" href="http://maven.apache.org/"/>
|
||||
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
|
||||
</links>
|
||||
|
||||
<menu name="Maven 2.0">
|
||||
<item name="Introduction" href="index.html"/>
|
||||
<item name="Download" href="download.html"/>
|
||||
<item name="General Information" href="about.html"/>
|
||||
<item name="For Maven 1.0 Users" href="maven1.html"/>
|
||||
<item name="Road Map" href="roadmap.html" />
|
||||
</menu>
|
||||
<menu name="User's Guide">
|
||||
<item name="Getting Started" href="getting-started.html"/>
|
||||
<item name="Configuration" href="configuration.html"/>
|
||||
<item name="Dependency Mechanism" href="dependencies.html"/>
|
||||
<item name="Developing Plugins with Marmalade" href="developers/developing-plugins-with-marmalade.html"/>
|
||||
</menu>
|
||||
<menu name="Reference">
|
||||
<item name="Project Descriptor" href="project-descriptor.html"/>
|
||||
<item name="Settings Descriptor" href="settings-descriptor.html"/>
|
||||
<item name="Available Plugins" href="plugin-list.html"/>
|
||||
<item name="Ant Tasks" href="ant-tasks.html"/>
|
||||
</menu>
|
||||
<menu name="Developers">
|
||||
<item name="Documentation Needed" href="docs-required.html"/>
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
|
|
@ -25,6 +25,14 @@
|
|||
Generate an Ant build file for the project
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="plugins/maven-archetype-plugin"><code>archetype</code></a>
|
||||
</td>
|
||||
<td>
|
||||
Generate a skeleton project structure from an archetype.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="plugins/maven-assembly-plugin"><code>assembly</code></a>
|
||||
|
|
@ -22,24 +22,6 @@
|
|||
We will continue with the successful technique from Maven 1.0 of making plugins available on a separate
|
||||
release schedule so that new features can be obtained as they are ready and tested.
|
||||
</p>
|
||||
<subsection name="Maven 2.0 alpha 2">
|
||||
<p>
|
||||
<i>Expected Release: </i> 13 May 2005
|
||||
</p>
|
||||
<p>
|
||||
<i>Aims and features:</i> This release is expected to be much more architecturally stable, making early adoption
|
||||
a real possiblity. At this point, there are still only the core plugins available.
|
||||
</p>
|
||||
<ul>
|
||||
<li>Basic site generation</li>
|
||||
<li>Improved error handling</li>
|
||||
<li>Published Mojo and Plugin API</li>
|
||||
<li>Inclusion of Ant tasks for Maven 2.0</li>
|
||||
<li>Preliminary Beanshell Mojo support</li>
|
||||
<li>Miscellaneous feature updates</li>
|
||||
<li>Bugfixes</li>
|
||||
</ul>
|
||||
</subsection>
|
||||
<subsection name="Maven 2.0 alpha 3">
|
||||
<p>
|
||||
<i>Expected Release: </i> mid-June 2005
|
||||
|
|
@ -59,6 +41,7 @@
|
|||
<li>Release assistance</li>
|
||||
<li>Miscellaneous feature updates</li>
|
||||
<li>Bugfixes</li>
|
||||
<li>Preliminary Beanshell Mojo support</li>
|
||||
</ul>
|
||||
</subsection>
|
||||
<subsection name="Maven 2.0 beta 1">
|
||||
|
|
|
|||
Loading…
Reference in New Issue