You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by br...@apache.org on 2005/03/02 06:45:56 UTC
svn commit: r155880 - in maven/maven-1/core/trunk/xdocs: ./ developers/
project/ reference/ reference/ide/ start/ using/
Author: brett
Date: Tue Mar 1 21:45:51 2005
New Revision: 155880
URL: http://svn.apache.org/viewcvs?view=rev&rev=155880
Log:
documentation updates, link cleanup
Modified:
maven/maven-1/core/trunk/xdocs/developers/building-from-source.xml
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/reference/articles.xml
maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml
maven/maven-1/core/trunk/xdocs/reference/ide/index.xml
maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
maven/maven-1/core/trunk/xdocs/reference/project-descriptor.xml
maven/maven-1/core/trunk/xdocs/reference/properties.xml
maven/maven-1/core/trunk/xdocs/start/release-notes-LATEST.xml
maven/maven-1/core/trunk/xdocs/using/bestpractices.xml
maven/maven-1/core/trunk/xdocs/using/index.xml
maven/maven-1/core/trunk/xdocs/using/scm.xml
Modified: maven/maven-1/core/trunk/xdocs/developers/building-from-source.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/developers/building-from-source.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/developers/building-from-source.xml (original)
+++ maven/maven-1/core/trunk/xdocs/developers/building-from-source.xml Tue Mar 1 21:45:51 2005
@@ -183,7 +183,8 @@
</p>
<p>
It is also possible to use the <code>multiproject</code> goals to do this from the <code>maven-plugins</code>
- directory. For more information, refer to the <a href="/reference/plugins/">Maven Plugins project documentation.</a>
+ directory. For more information, refer to the <a href="../reference/plugins/">Maven Plugins project
+ documentation.</a>
</p>
<table>
<tr>
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&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/navigation-pdf.xml (original)
+++ maven/maven-1/core/trunk/xdocs/navigation-pdf.xml Tue Mar 1 21:45:51 2005
@@ -120,9 +120,10 @@
<!-- TODO: contributing a better name? include submitting patches, JIRA, releasing plugins, more foundation stuff, etc -->
<!-- TODO: on releasing plugins - document should be about versioning and releasing, be a best practice? -->
<menu name="Maven Developers">
- <item name="Building from Source" href="/developers/building-from-source.html" />
- <item name="Apache Resources" href="/developers/apache.html" />
- <item name="Releasing Plugins" href="/developers/releasing-plugins.html" />
+ <item name="Building from Source" href="/developers/building-from-source.html" />
+ <item name="Documenting" href="/developers/documentation-conventions.html" />
+ <item name="Making Releases" href="/developers/making-releases.html" />
+ <item name="Apache Resources" href="/developers/apache.html" />
</menu>
<!-- TODO: ideas
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&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/navigation.xml (original)
+++ maven/maven-1/core/trunk/xdocs/navigation.xml Tue Mar 1 21:45:51 2005
@@ -25,7 +25,7 @@
<links>
<item name="Maven" href="/index.html"/>
<item name="Plugins" href="/reference/plugins/index.html"/>
- <item name="Plugins Sandbox" /><!--href="/plugins-sandbox/index.html"/>-->
+ <item name="Plugins Sandbox" href="/plugins-sandbox/index.html"/>
<item name="SCM" /><!-- href="/scm/index.html" /> -->
<item name="Wagon" /><!-- href="/wagon/index.html" /> -->
<item name="Components" href="/project/components.html"/>
@@ -97,7 +97,7 @@
<menu name="Getting Plugins">
<!-- TODO: remove 3rd party bit from there, aggregate plugins to front page but add explanation -->
<item name="Maven Plugins" href="/reference/plugins/index.html" />
- <item name="Maven Plugin Sandbox" /><!-- href="/plugins-sandbox/index.html" /> -->
+ <item name="Maven Plugin Sandbox" href="/plugins-sandbox/index.html" />
<item name="Maven Plugins @ sf.net" href="http://maven-plugins.sourceforge.net/" />
<item name="Other 3rd Party Plugins" href="/reference/3rdparty.html" />
</menu>
@@ -111,7 +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" /> -->
- <item name="Maven Jelly Tags" href="/reference/maven-jelly-tags/index.html" />
+ <item name="Maven Jelly Tags" href="/reference/maven-jelly-tags/index.html" />
</item>
</menu>
@@ -129,7 +129,7 @@
<menu name="Developers" type="footer">
<item name="Building from Source" href="/developers/building-from-source.html" />
<item name="Documenting" href="/developers/documentation-conventions.html" />
- <item name="Releasing Plugins" href="/developers/releasing-plugins.html" />
+ <item name="Making Releases" href="/developers/making-releases.html" />
<item name="Apache Resources" href="/developers/apache.html" />
</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&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/project/components.xml (original)
+++ maven/maven-1/core/trunk/xdocs/project/components.xml Tue Mar 1 21:45:51 2005
@@ -33,7 +33,7 @@
</p>
<subsection name="Maven Model Library">
<p>
- The <!--TODO [later]: build site... 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.
Modified: maven/maven-1/core/trunk/xdocs/reference/articles.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/articles.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/articles.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/articles.xml Tue Mar 1 21:45:51 2005
@@ -28,7 +28,7 @@
<section name="Maven in the Press">
<p>
Have written or would like to write a story on Maven?
- <a href="/mail-lists.html">Contact us</a> on the developers
+ <a href="../mail-lists.html">Contact us</a> on the developers
mailing list.
</p>
<table>
@@ -194,7 +194,7 @@
</table>
<p>
Have written or would like to write an article on Maven?
- <a href="/mail-lists.html">Contact us</a> on the developers
+ <a href="../mail-lists.html">Contact us</a> on the developers
mailing list to include it here.
</p>
</section>
Modified: maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/ide/idea.xml Tue Mar 1 21:45:51 2005
@@ -76,7 +76,7 @@
As above, but use <code>idea</code> (or <code>idea:multiproject</code>) as the parameters.
Name this "Regenerate IntelliJ project". When run, it will regenerate all your IntelliJ projects, and
IntelliJ will prompt you to reload your project. For more information, see the
- <a href="/reference/plugins/idea/">IntelliJ IDEA Plugin</a> documentation.
+ <a href="../plugins/idea/">IntelliJ IDEA Plugin</a> documentation.
</li>
<li>
As above, but use <code>$FileDir$</code> instead of <code>$ProjectFileDir$</code>. This is useful
Modified: maven/maven-1/core/trunk/xdocs/reference/ide/index.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/ide/index.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/ide/index.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/ide/index.xml Tue Mar 1 21:45:51 2005
@@ -49,10 +49,10 @@
Maven also provides plugins for several IDEs that will generate project files from your Maven
project descriptor. Please refer the the plugin documentation for your IDE:
<ul>
- <li><a href="/reference/plugins/idea/">IntelliJ IDEA</a></li>
- <li><a href="/reference/plugins/eclipse/">Eclipse</a></li>
- <li><a href="/reference/plugins/jbuilder/">JBuilder</a></li>
- <li><a href="/reference/plugins/jdee/">JDEE</a></li>
+ <li><a href="../plugins/idea/">IntelliJ IDEA</a></li>
+ <li><a href="../plugins/eclipse/">Eclipse</a></li>
+ <li><a href="../plugins/jbuilder/">JBuilder</a></li>
+ <li><a href="../plugins/jdee/">JDEE</a></li>
</ul>
</p>
</section>
Modified: maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/internal-repositories.xml Tue Mar 1 21:45:51 2005
@@ -43,7 +43,7 @@
</p>
<p>
Additionally, you may want to share the repository server with your generated project sites. For more
- information on creating and deploying sites, see <a href="/using/site.html">Creating a Site</a>.
+ information on creating and deploying sites, see <a href="../using/site.html">Creating a Site</a>.
</p>
<subsection name="Setting up the Internal Repository">
<p>
Modified: maven/maven-1/core/trunk/xdocs/reference/project-descriptor.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/project-descriptor.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/project-descriptor.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/project-descriptor.xml Tue Mar 1 21:45:51 2005
@@ -42,7 +42,7 @@
<p>
For reference, the XML schema used to validate the project
descriptor is available at <a
- href="http://maven.apache.org/xsd/maven-project-3.0.0.xsd">http://maven.apache.org/xsd/maven-project-3.0.0.xsd</a>.
+ href="../xsd/maven-project-3.0.0.xsd">http://maven.apache.org/xsd/maven-project-3.0.0.xsd</a>.
</p>
</section>
Modified: maven/maven-1/core/trunk/xdocs/reference/properties.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/reference/properties.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/reference/properties.xml (original)
+++ maven/maven-1/core/trunk/xdocs/reference/properties.xml Tue Mar 1 21:45:51 2005
@@ -287,7 +287,7 @@
<td>
The repository maven should use to download artifacts
(jars etc) that it can't find in the local repository.
- You should set this to one of the <a href="/faq.html#ibiblio-mirrors">Ibiblio mirrors</a>.
+ You should set this to one of the <a href="../faq.html#ibiblio-mirrors">Ibiblio mirrors</a>.
You can also specify multiple repositories, separated by commas.
</td>
<td><code>http://www.ibiblio.org/maven</code></td>
Modified: maven/maven-1/core/trunk/xdocs/start/release-notes-LATEST.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/start/release-notes-LATEST.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/start/release-notes-LATEST.xml (original)
+++ maven/maven-1/core/trunk/xdocs/start/release-notes-LATEST.xml Tue Mar 1 21:45:51 2005
@@ -29,7 +29,7 @@
<p>
The Apache Maven team is pleased to announce the release of Maven 1.0.2.
</p><p>
-<a href="http://maven.apache.org/start/download.html">http://maven.apache.org/start/download.html</a>
+<a href="download.html">http://maven.apache.org/start/download.html</a>
</p><p>
This release contains further bugfixes since the Maven 1.0 release. In addition, all of the latest stable plugin releases are included, which include both bugfixes and some new features.
</p><p>
@@ -41,7 +41,7 @@
object model. Maven also provides tools to create source metrics, change logs
based directly on source repository, and source cross-references.
</p><p>
-To see a list of changes to Maven, please refer to the <a href="/changes-report.html#1_0_2">Changes Report</a>, or the brief summary below:
+To see a list of changes to Maven, please refer to the <a href="../changes-report.html#1_0_2">Changes Report</a>, or the brief summary below:
</p>
<ul>
<li>[<a href='http://jira.codehaus.org/browse/MAVEN-1428'>MAVEN-1428</a>] - "Response content length not known"</li>
@@ -52,13 +52,13 @@
<li>[<a href='http://jira.codehaus.org/browse/MAVEN-1518'>MAVEN-1518</a>] - Wrong behaviour for non existing overwritten dependency</li>
</ul>
<p>
-Please note that each plugin has its own changes report - please refer to the <a href="/reference/plugins/">plugins site</a> to see the plugin you are interested in.
+Please note that each plugin has its own changes report - please refer to the <a href="../reference/plugins/">plugins site</a> to see the plugin you are interested in.
</p>
<p>
We hope you enjoy using Maven! If you have any questions, please consult:
<ul>
-<li>the FAQ: <a href="http://maven.apache.org/faq.html">http://maven.apache.org/faq.html</a></li>
-<li> the maven-user mailing list: <a href="http://maven.apache.org/mail-lists.html">http://maven.apache.org/mail-lists.html</a></li>
+<li>the FAQ: <a href="../faq.html">http://maven.apache.org/faq.html</a></li>
+<li> the maven-user mailing list: <a href="../mail-lists.html">http://maven.apache.org/mail-lists.html</a></li>
</ul>
</p><p>
For news and information, see:
Modified: maven/maven-1/core/trunk/xdocs/using/bestpractices.xml
URL: http://svn.apache.org/viewcvs/maven/maven-1/core/trunk/xdocs/using/bestpractices.xml?view=diff&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/using/bestpractices.xml (original)
+++ maven/maven-1/core/trunk/xdocs/using/bestpractices.xml Tue Mar 1 21:45:51 2005
@@ -26,8 +26,59 @@
<body>
<section name="Best Practices">
- <!-- TODO -->
+ <!-- TODO: more to do -->
<p>...</p>
+ <subsection name="Keep the Site Documentation Updated">
+ <p>
+ The
+ <code>xdocs</code> directory should contain a set of documentation that can be published as a site,
+ giving users and developers instructions on how to use the project.
+ </p>
+ <p>
+ When you make changes to the project, make sure the documentation is kept up to date.
+ For plugins, consider especially the
+ <code>xdocs/goals.xml</code> and
+ <code>xdocs/properties.xml</code> files. If the plugin has no
+ xdocs, you can generate skeletons using
+ <code>maven plugin:generate-docs</code>.
+ </p>
+ </subsection>
+ <subsection name="Maintain a Change Log">
+ <p>
+ The
+ <code>xdocs/changes.xml</code> file can be used to track changes as they are made, including who made them,
+ what ticket number they relate to, and who they were contributed by if it was submitted as a patch.
+ </p>
+ <p>
+ Maintaining this gives a more readable change log than that provided by the SCM reports, and can be used to
+ generate documentation and release notes.
+ </p>
+ <p>
+ When committing a change, you should edit and commit
+ <code>xdocs/changes.xml</code> (create it if it does not
+ exist) and describe the change according to the format given in the
+ <a href="../reference/plugins/changes/">changes plugin</a>.
+ </p>
+ <p>
+ <b>Note:</b> In the future, Maven should be able to integrate tightly with your issue tracking system to
+ reduce the need for this.
+ </p>
+ </subsection>
+ <subsection name="Project Development Cycle">
+ <p>
+ Whenever you start making changes after a recent release, you should check the <code>currentVersion</code>
+ tag in <code>project.xml</code> and ensure that it is <code><i>nextVersion</i>-SNAPSHOT</code>.
+ </p>
+ <p>
+ By tagging the version as <code>-SNAPSHOT</code> it signifies it is not released (so won't accidentally
+ overwrite the official release), and has the advantage that when published, newer versions will be downloaded
+ if it changes.
+ </p>
+ <p>
+ Part of the release process is to set <code>currentVersion</code> to the actual version released.
+ For more information, set <a href="releasing.html">Making Releases</a>.
+ </p>
+ </subsection>
</section>
</body>
</document>
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&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/using/index.xml (original)
+++ maven/maven-1/core/trunk/xdocs/using/index.xml Tue Mar 1 21:45:51 2005
@@ -32,15 +32,15 @@
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>
+ <li><a href="jar.html">Building JARs</a> - How to build an individual library</li>
+ <li><a href="tests.html">Unit Testing</a> - Running unit tests</li>
+ <li><a href="war.html">Web Applications</a> - Working with web applications</li>
+ <li><a href="site.html">Creating a Site</a> - Adding to the project web site</li>
+ <li><a href="scm.html">Source Control</a> - Working with SCMs</li>
+ <li><a href="releasing.html">Making Releases</a> - How to cutting a release</li>
+ <li><a href="multiproject.html">Multiple Modules</a> - Building multiple libraries and applications together</li>
+ <li><a href="migrating.html">Migrating from Ant</a> - Where to start if you already have <code>build.xml</code></li>
+ <li><a href="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">
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&r1=155879&r2=155880
==============================================================================
--- maven/maven-1/core/trunk/xdocs/using/scm.xml (original)
+++ maven/maven-1/core/trunk/xdocs/using/scm.xml Tue Mar 1 21:45:51 2005
@@ -36,7 +36,7 @@
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-->
+ 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>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org