You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by ka...@apache.org on 2002/03/29 07:49:48 UTC
cvs commit: jakarta-turbine-maven/xdocs anakia.xml getting-started.xml project.xml
kaz 02/03/28 22:49:48
Modified: xdocs getting-started.xml project.xml
Added: xdocs anakia.xml
Log:
Added a document for existing Anakia users that want to use Maven to
generate their project's site with the new look and feel. The document
refers the reader to other documentation but provides some additional
details specific to Anakia. Its just a start (you might be able to tell
that I'm getting sleepy)
Revision Changes Path
1.10 +9 -0 jakarta-turbine-maven/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/getting-started.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- getting-started.xml 28 Mar 2002 18:57:11 -0000 1.9
+++ getting-started.xml 29 Mar 2002 06:49:48 -0000 1.10
@@ -76,6 +76,15 @@
This document provides you with step by step instructions.
</td>
</tr>
+ <tr><td><a href="anakia.html">Anakia Users</a></td>
+ <td>
+ If you currently use Anakia to generate documentation, you
+ can easily give your site a facelift with Maven! Maven
+ can generate an entire site from your Anakia documentation
+ for you! This is a great opportunity to start integrating
+ Maven into your project.
+ </td>
+ </tr>
</table>
</subsection>
</section>
1.24 +1 -0 jakarta-turbine-maven/xdocs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-turbine-maven/xdocs/project.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -u -r1.23 -r1.24
--- project.xml 28 Mar 2002 18:57:11 -0000 1.23
+++ project.xml 29 Mar 2002 06:49:48 -0000 1.24
@@ -28,6 +28,7 @@
<item name="Integrate" href="/integrate.html"/>
<item name="Use" href="/use.html"/>
<item name="Build" href="/bootstrap.html"/>
+ <item name="Anakia Users" href="/anakia.html"/>
</menu>
<menu name="Reference">
<item name="Project Descriptor" href="/project-descriptor.html"/>
1.1 jakarta-turbine-maven/xdocs/anakia.xml
Index: anakia.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Anakia to Maven</title>
<author email="pete@kazmier.com">Pete Kazmier</author>
</properties>
<body>
<section name="Anakia to Maven">
<p>
This document has been specifically created for users of Anakia.
If you use Anakia to generate a website for your project, you
can easily migrate to Maven and automatically inherit a great
look and feel designed by CSS experts. This is an ideal
opportunity for you to start integrating Maven into your
project. Using Maven is not an all or nothing scenario, with
very little effort you can use Maven to generate only your site
documentation. As you become more familiar with Maven, you can
then slowly start utilizing other features of Maven.
</p>
<p>
The process of creating a Maven-generated site from your Anakia
documentation is outlined below:
</p>
<ul>
<p>
<li>
Install Maven on your system. Please refer to the
<a href="getting-started.html">Getting Started</a>
documentation for assistance.
</li>
</p>
<p>
<li>
Create a project descriptor and then add Maven delegators to
your build file. Please refer to the <a
href="integrate.html">Integration</a> document for
assistance. If you are only interested in using Maven for
the generation of your site, you do not have to complete the
<build> element section of the project descriptor.
</li>
</p>
<p>
<li>
Use Maven to generate your site by invoking the
<code>maven:site</code> Ant target. You can also
automatically deploy your site to a web server with
<code>maven:deploy-site</code>.
</li>
</p>
</ul>
<p>
If your project does not store its documentation in the
<code>xdocs</code> directory located in the base directory of
the project, you'll have to define the Ant property
<code>${docs.src}</code> in a properties file or via the command
line to point to the appropriate location.
</p>
<p>
Prior to writing this document, several random Jakarta projects
were selected and their documentation was generated using Maven
to demonstrate how easy it is to switch from Anakia to Maven.
Give it a try, we promise you'll like it!
</p>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>