Author: brett Date: Thu Jan 27 03:33:54 2005 New Revision: 126599 URL: http://svn.apache.org/viewcvs?view=rev&rev=126599 Log: updated documentation Removed: maven/maven-1/core/trunk/xdocs/about/whymaven.xml Modified: maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml maven/maven-1/core/trunk/xdocs/faq.fml maven/maven-1/core/trunk/xdocs/navigation-pdf.xml maven/maven-1/core/trunk/xdocs/navigation.xml maven/maven-1/core/trunk/xdocs/project/components.xml maven/maven-1/core/trunk/xdocs/using/index.xml maven/maven-1/core/trunk/xdocs/using/scm.xml maven/maven-1/core/trunk/xdocs/using/site.xml
Deleted: /maven/maven-1/core/trunk/xdocs/about/whymaven.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/about/whymaven.xml?view=auto&rev=126598 ============================================================================== Modified: maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml (original) +++ maven/maven-1/core/trunk/xdocs/developers/documentation-conventions.xml Thu Jan 27 03:33:54 2005 @@ -26,7 +26,7 @@ <body> <section name="Documentation Conventions"> - <!-- TODO [later]: NOT LINKED IN + <!-- TODO [later]: DRAFT - needs to be reviewed by developers Think about things like: Modified: maven/maven-1/core/trunk/xdocs/faq.fml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/faq.fml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/faq.fml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/faq.fml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/faq.fml (original) +++ maven/maven-1/core/trunk/xdocs/faq.fml Thu Jan 27 03:33:54 2005 @@ -17,7 +17,7 @@ */ --> -<!-- TODO: faqs need some sorting --> +<!-- TODO [later]: faqs need some sorting --> <faqs title="Frequently Asked Questions"> <part id="general"> @@ -92,7 +92,7 @@ </faq> </part> - <!-- TODO: probably a document --> + <!-- TODO [later]: probably a document --> <part id="contributing"> <title>Contributing</title> <faq id="bug-reporting"> @@ -515,8 +515,8 @@ <question>How do I get or set plugin properties from Jelly?</question> <answer> <p>Plugin properties can be used with the following tags: - <a href="jelly-tags/tags.html#maven:get">maven:get</a> and - <a href="jelly-tags/tags.html#maven:set">maven:set</a>. + <a href="reference/maven-jelly-tags/tags.html#maven:get">maven:get</a> and + <a href="reference/maven-jelly-tags/tags.html#maven:set">maven:set</a>. (These replace the deprecated versions of <code>${pom.getPluginContext(...).get/setVariable()}</code> and <code>maven:pluginVar</code>.)</p> <p>Example:</p> Modified: maven/maven-1/core/trunk/xdocs/navigation-pdf.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation-pdf.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/navigation-pdf.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/navigation-pdf.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/navigation-pdf.xml (original) +++ maven/maven-1/core/trunk/xdocs/navigation-pdf.xml Thu Jan 27 03:33:54 2005 @@ -46,7 +46,6 @@ <menu name="About Maven"> <item name="What is Maven?" href="/about/whatismaven.html" /> <item name="What is Maven Not?" href="/about/whatismaven.html#What_is_Maven_Not_" /> - <item name="Why Maven?" href="/about/whymaven.html" /> <item name="Powered by Maven" href="/about/powered.html" /> </menu> Modified: maven/maven-1/core/trunk/xdocs/navigation.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/navigation.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/navigation.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/navigation.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/navigation.xml (original) +++ maven/maven-1/core/trunk/xdocs/navigation.xml Thu Jan 27 03:33:54 2005 @@ -49,7 +49,6 @@ <menu name="About Maven"> <item name="What is Maven?" href="/about/whatismaven.html" /> - <item name="Why use Maven?" href="/about/whymaven.html" /> <item name="Feature Summary" href="/about/features.html" /> <item name="Powered by Maven" href="/about/powered.html" /> </menu> @@ -65,10 +64,10 @@ <item name="Using Maven" collapse="true" href="/using/index.html"> <item name="Building JARs" href="/using/jar.html" /> <item name="Unit Testing" href="/using/tests.html" /> - <item name="Web Applications" href="/using/war.html" /> <item name="Creating a Site" href="/using/site.html" /> <item name="Source Control" href="/using/scm.html" /> <item name="Making Releases" href="/using/releasing.html" /> + <item name="Web Applications" href="/using/war.html" /> <item name="Multiple Modules" href="/using/multiproject.html" /> <item name="Migrating from Ant" href="/using/migrating.html" /> <item name="Best Practices" href="/using/bestpractices.html" /> @@ -112,8 +111,7 @@ <item name="Maven SCM" /><!-- href="/scm/index.html" /> --> <item name="Components" collapse="true" href="/project/components.html"> <item name="Maven Model Library" /><!-- href="/components/maven-model/index.html" /> --> -<!-- TODO: check link --> - <item name="Maven Jelly Tags" /><!-- href="/jelly-tags/index.html" /> --> + <item name="Maven Jelly Tags" href="/reference/maven-jelly-tags/index.html" /> </item> </menu> Modified: maven/maven-1/core/trunk/xdocs/project/components.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/project/components.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/project/components.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/project/components.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/project/components.xml (original) +++ maven/maven-1/core/trunk/xdocs/project/components.xml Thu Jan 27 03:33:54 2005 @@ -33,7 +33,7 @@ </p> <subsection name="Maven Model Library"> <p> - The <a href="/components/maven-model/index.html">Maven Model Library</a> is used in Maven 1.1 and above + The <!--TODO [later]: build site... a href="/components/maven-model/index.html" -->Maven Model Library<!--/a--> is used in Maven 1.1 and above to read project descriptors (<code>project.xml</code> and <code>pom.xml</code>). It also contains the object definitions of the model. It does not, however, handle interpolation or inheritence - this is a job left to the Maven core. @@ -45,8 +45,8 @@ </subsection> <subsection name="Maven Jelly Tag Library"> <p> - The <a href="/jelly-tags/index.html">Maven Jelly Tag Library</a> can be used from a Jelly based application - to perform the tasks of any of the <code><maven:*/></code> tags. + The <a href="reference/maven-jelly-tags/index.html">Maven Jelly Tag Library</a> can be used from a Jelly based + application to perform the tasks of any of the <code><maven:*/></code> tags. </p> </subsection> </section> Modified: maven/maven-1/core/trunk/xdocs/using/index.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/using/index.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/using/index.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/using/index.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/using/index.xml (original) +++ maven/maven-1/core/trunk/xdocs/using/index.xml Thu Jan 27 03:33:54 2005 @@ -26,8 +26,32 @@ <body> <section name="Using Maven"> - <!-- TODO --> - <p>...</p> + <p> + This guide will describe how to work with Maven to build different types of projects. + If you haven't already, it is recommended that you first read the "Getting Started" documents found in the + navigation of this site for an introduction to working with Maven. + </p> + <ul> + <li><a href="/using/jar.html">Building JARs</a> - How to build an individual library</li> + <li><a href="/using/tests.html">Unit Testing</a> - Running unit tests</li> + <li><a href="/using/war.html">Web Applications</a> - Working with web applications</li> + <li><a href="/using/site.html">Creating a Site</a> - Adding to the project web site</li> + <li><a href="/using/scm.html">Source Control</a> - Working with SCMs</li> + <li><a href="/using/releasing.html">Making Releases</a> - How to cutting a release</li> + <li><a href="/using/multiproject.html">Multiple Modules</a> - Building multiple libraries and applications together</li> + <li><a href="/using/migrating.html">Migrating from Ant</a> - Where to start if you already have <code>build.xml</code></li> + <li><a href="/using/bestpractices.html">Best Practices</a> - Why Maven encourages what it does, and how to take advantage of it</li> + </ul> + </section> + <section name="Further Reading"> + <p> + Further topics in the User's Guide include: + </p> + <ul> + <li><a href="customising.html">Customising a Build</a> - how to change behaviour, add scripting and create + your own plugins</li> + <li><a href="repositories.html">Repositories</a> - how to manage your own artifact repository</li> + </ul> </section> </body> </document> Modified: maven/maven-1/core/trunk/xdocs/using/scm.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/using/scm.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/using/scm.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/using/scm.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/using/scm.xml (original) +++ maven/maven-1/core/trunk/xdocs/using/scm.xml Thu Jan 27 03:33:54 2005 @@ -1,7 +1,7 @@ <?xml version="1.0"?> <!-- /* - * Copyright 2001-2004 The Apache Software Foundation. + * Copyright 2001-2005 The Apache Software Foundation. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,8 +26,85 @@ <body> <section name="Working with Source Control"> - <!-- TODO --> - <p>...</p> + <p> + Working with your source control system in Maven is quite simple. Maven can provide the following services: + </p> + <ul> + <li>Common tasks such as checking out code, tagging the current code, and performing an update</li> + <li>Generating reports on the recent usage history of source control</li> + <li>Providing links to a web view of the source control, and if desired publishing that information to + the project site</li> + </ul> + <p> + Support is provided by the <!-- TODO [later]: link to mini site... a href="/scm/index.html"-->Maven SCM<!--/a--> + subproject. This provides support for the following SCM systems: + </p> + <ul> + <li>CVS</li> + <li>Subversion</li> + <li>ClearCase (partial)</li> + <li>Perforce (partial)</li> + <li>StarTeam (partial)</li> + <li>Visual SourceSafe (planned)</li> + </ul> + <p> + Configuration is extremely simple - in most cases, you need only specify the <code><connection/></code> + string in the <code><repository/></code> element of your POM. Specifics about this connection string + can be found in the <a href="../reference/plugins/scm/scmurl.html">SCM plugin documentation</a>. + </p> + <subsection name="Performing Common Tasks"> + <p> + It is possible to perform several common tasks with Maven. These can be particularly useful + for automation in your development environment, or in continuous integration. + </p> + <p> + There are also goals that provide assistance with making releases from your SCM. + </p> + <p> + For more information about common tasks and SCM based releases, see the + <a href="../reference/plugins/scm/index.html">SCM Plugin Documentation</a>. This contains a complete guide to + the <code>scm:</code> goals and related properties. + </p> + <p> + For general information on making releases with Maven, please see <a href="releasing.html">Making + Releases</a>. + </p> + </subsection> + <subsection name="Generating Reports"> + <p> + Maven provides three different reports on SCM usage that can be included in your project site. + These are provided by the <a href="../reference/plugins/changelog/index.html">Change Log</a>, + <a href="../reference/plugins/file-activity/index.html">File Activity</a> and + <a href="../reference/plugins/developer-activity/index.html">Developer Activity</a> plugins. + </p> + <p> + These are included in your project site by default, however if you would like to explicitly select them + for your project, add any or all of the following lines to <code>project.xml</code> inside the + <code><reports/></code> section: + </p> + <source><![CDATA[<report>maven-changelog-plugin</report> +<report>maven-file-activity-plugin</report> +<report>maven-developer-activity-plugin</report>]]></source> + <p> + For examples of these reports, please see the ones published for this project: + <a href="../changelog-report.html">Change Log</a>, <a href="../file-activity-report.html">File Activity</a>, + and <a href="../developer-activity-report.html">Developer Activity</a>. + </p> + <p> + There are other SCM reports available for Maven, such as the excellent StatCVS plugin. + These are included on the <a href="../reference/3rdparty.html">3rd Party Plugins</a> list. + </p> + </subsection> + <subsection name="Adding SCM Information to Your Site"> + <p> + The source control information for the project is included by default in the project site. For example, + see the <a href="../cvs-usage.html">CVS Usage</a> page for this project. + </p> + <p> + For more information, please see <a href="site.html">Creating a Site</a>. + </p> + </subsection> </section> </body> </document> + Modified: maven/maven-1/core/trunk/xdocs/using/site.xml Url: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/using/site.xml?view=diff&rev=126599&p1=maven/maven-1/core/trunk/xdocs/using/site.xml&r1=126598&p2=maven/maven-1/core/trunk/xdocs/using/site.xml&r2=126599 ============================================================================== --- maven/maven-1/core/trunk/xdocs/using/site.xml (original) +++ maven/maven-1/core/trunk/xdocs/using/site.xml Thu Jan 27 03:33:54 2005 @@ -26,6 +26,7 @@ <body> <!-- TODO: flesh this out with a full walk through (visual walkthrough of maven site) + TODO: talk about generated docs - in particular have already referenced cvs-usage from scm.xml <section name="Site Generation"> <p> Maven can be used to generate an entire web site for your --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
