dion 2003/08/19 19:06:28
Modified: xdocs navigation.xml
Added: xdocs/reference/developers/ide/eclipse eclipse6.png
eclipse3.png eclipse2.png eclipse1.png eclipse7.png
index.xml eclipse4.png eclipse5.png
xdocs/reference/developers index.xml releasing-plugins.xml
xdocs/reference/developers/ide index.xml
Removed: xdocs/reference/ide/eclipse eclipse2.png eclipse7.png
eclipse3.png eclipse4.png eclipse5.png index.xml
eclipse1.png eclipse6.png
xdocs/reference/ide index.xml
Log:
Rework docs to have developer stuff all in one section.
Add the releasing plugins doc from the wiki
Revision Changes Path
1.29 +8 -6 maven/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/navigation.xml,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- navigation.xml 20 Aug 2003 00:58:43 -0000 1.28
+++ navigation.xml 20 Aug 2003 02:06:27 -0000 1.29
@@ -19,14 +19,9 @@
<item name="Anakia Users" href="/start/anakia.html"/>
</item>
<item name="Reference" href="/reference/index.html"
collapse="true">
- <item name="Project Descriptors"
href="/reference/project-descriptor.html"/>
+ <item name="Project Descriptor"
href="/reference/project-descriptor.html"/>
<item name="User Guide" href="/reference/user-guide.html"/>
<item name="Plugins" href="/reference/plugins/index.html"/>
- <item name="Developer Guide"
href="/reference/developers/developer-guide.html" collapse="true">
- <item name="IDE Configuration" href="/reference/ide/index.html">
- <item name="Eclipse" href="/reference/ide/eclipse/index.html"/>
- </item>
- </item>
<item name="FAQ" href="/faq.html"/>
<item name="Project Layout" href="/reference/dirlayout.html"
collapse="true">
<item name="Site Navigation" href="/site.html"/>
@@ -40,6 +35,13 @@
<item name="Dependencies" href="/ant-guide/qna/inprogress.html"/>
<item name="Ant Targets" href="/ant-guide/qna/inprogress.html"/>
<item name="Properties" href="/ant-guide/qna/properties.html"/>
+ </item>
+ </item>
+ <item name="Developers" href="/reference/developers/index.html"
collapse="true">
+ <item name="Developer's Guide"
href="/reference/developers/developer-guide.html"/>
+ <item name="Releasing Plugins"
href="/reference/developers/releasing-plugins.html"/>
+ <item name="IDE Configuration"
href="/reference/developers/ide/index.html">
+ <item name="Eclipse"
href="/reference/developers/ide/eclipse/index.html"/>
</item>
</item>
<item name="Maven Wiki" href="http://wiki.codehaus.org/maven/"/>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse6.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse3.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse2.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse1.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse7.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Eclipse Configuration</title>
<author email="[EMAIL PROTECTED]">Ben Walding</author>
</properties>
<body>
<section name="Java | Code Formatter">
<style type="text/css">
img.screenshot {
padding: 10px;
}
</style>
<subsection name="New Lines">
<img class="screenshot" src="eclipse1.png"/>
</subsection>
<subsection name="Line Splitting">
<img class="screenshot" src="eclipse2.png"/>
</subsection>
</section>
<section name="Team | File Content">
<p>
This ensures that *.jsl and *.jelly files are checked into
CVS as ASCII.
</p>
<img class="screenshot" src="eclipse3.png"/>
</section>
<section name="Workbench | Editors | Text Editor">
<img class="screenshot" src="eclipse4.png"/>
</section>
<section name="Java | Classpath Variables">
<p>
This lets the relative dependencies generated by
<code>maven eclipse</code> be found by Eclipse.
</p>
<p>
<code>MAVEN_REPO</code> should be set to the location of
your local maven repository (maven.repo.local)
</p>
<img class="screenshot" src="eclipse5.png"/>
</section>
<section name="Java | Editor">
<subsection name="Appearance">
<img class="screenshot" src="eclipse6.png"/>
</subsection>
<subsection name="Typing">
<p>Insert spaces for tabs</p>
<img class="screenshot" src="eclipse7.png"/>
</subsection>
</section>
</body>
</document>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse4.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/ide/eclipse/eclipse5.png
<<Binary file>>
1.1 maven/xdocs/reference/developers/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>Developer's Reference Documentation</title>
<author email="[EMAIL PROTECTED]">dIon Gillard</author>
</properties>
<body>
<section name="Overview">
<p>
These documents contain information relevant to people developing Maven
itself,
not for people wanting to use Maven for their development build tool.
</p>
</section>
</body>
</document>
1.1 maven/xdocs/reference/developers/releasing-plugins.xml
Index: releasing-plugins.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<title>Releasing Plugins</title>
</properties>
<body>
<section name="Releasing Plugins">
<p>
This page describes what Maven contributors or developers need to do when
modifying a Maven plugin in Maven CVS:
</p>
<ul>
<li>
Update <strong>xdocs/changes.xml</strong>
(create it if it does not exist) and describe the change, see
<a href="http://maven.apache.org/reference/plugins/changes/";>the changes
plugin</a>
or the format of the file.
</li>
<li>
Update the <strong>xdocs/goals.xml</strong>,
<strong>xdocs/properties.xml</strong> and other documentation files
in <strong>xdocs/</strong>, reflecting your change.
If the plugin has no xdocs, please generate skeletons using
<code>maven plugin:generate-docs</code>
</li>
<li>
Ensure that the version in plugin.xml is a SNAPSHOT, e.g.
<strong><currentVersion>1.1-SNAPSHOT</currentVersion></strong>,
and <b>not</b>
<strong><currentVersion>1.1</currentVersion></strong>.
Unless you are in the process of creating a release of course.
</li>
<li>
Make sure the <code><version></code> section of project.xml is
up to date. Create one if it is missing.
</li>
</ul>
</section>
<section name="Steps for releasing internal Maven plugins">
<ul>
<li>
<p>Modify the version in <code>project.xml</code> to remove the
<code>-SNAPSHOT</code> part
</p>
</li>
<li>
<p> Modify <code><version></code> in <code>project.xml</code>
</p>
</li>
<li>
<p> Modify <code>changes.xml</code> to put the release date
</p>
</li>
<li>
<p> Copy the new release documentation into the xdocs directory as
xdocs/releases/vX.Y and add this link to the project navigation.xml
</p>
</li>
<li>
<p> Add a download link in the project navigation
(<code>navigation.xml</code>).
For an example, see <a
href="http://maven.apache.org/reference/plugins/cactus";>cactus</a>.
</p>
</li>
<li>
<p> Upload the new version to
<a
href="http://www.ibiblio.org/maven/maven/plugins/";>http://www.ibiblio.org/maven/maven/plugins/</a>
using maven -DgroupId=maven -Dtype=plugin -Dartifact=/path/to/file
repository:copy-artifact
</p>
</li>
<li>
<p> Create an <code>announcements</code> directory in the project and inside
create a
<code>[major].[minor].ann</code> text file containing the announce of the
release.
For an example, see
<a
href="http://cvs.apache.org/viewcvs.cgi/maven/src/plugins-build/cactus/announcements/";>cactus</a>
</p>
</li>
<li>
<p> Send a quick release email to the Maven user list, using the content of
<code>[major].[minor].ann</code>.
</p>
</li>
<li>
<p> Tag the plugin project dir in CVS with
<code>MAVEN_[PROJECTNAME]_[MAJOR]_[MINOR]</code>
(for example <code>MAVEN_CACTUS_2_0</code>).
</p>
</li>
<li>
<p> Increase the version in <code>project.xml</code> and don't forget to
prepend <code>-SNAPSHOT</code>
</p>
</li>
<li>
<p> Update <code>project.xml</code> to add a new <code><version></code>
tag for <code>HEAD</code>
</p>
<p> <strong>Relax!</strong>' </p>
</li>
</ul>
</section>
<section name="Some related FAQs">
<ul>
<li>
<p> Q: When would I do a release?</p>
<p> A: At the moment, the plugins have the same
lifecycle as Maven as a whole. Thus the plugins need to be released at least
before Maven is released. Otherwise, you would do a release when you are
performing
a major change on a plugin that is breaking some compatibility and you want
to
make the earlier version available to support existing users so that they
can
still use the older version before they migrate to the new one.
</p>
<p>In the future, plugins will have their own release lifecycle.</p>
</li>
<li>
<p> Q: Why would I want to given all the pain it will take?</p>
<p> A: Several possible answers... :-) Pick yours. </p>
<ol>
<li><p> Because, making a release is honorific and you'll be thanked for
it! </p></li>
<li><p> Because you have no choice. It is a rule in Maven land that we
want to support
our existing user base. This is something that we may not have done
properly in the
past and we need to tackle this issue now.</p></li>
<li><p> Because this is a rule all committers on Maven have agreed on, so
you have
no choice :-) </p></li>
</ol>
</li>
<li><p> Q: What is the advantage of releasing new version of a plugin if no
one is whining
that the built version is broken?</p>
<p> A: Ideally plugin changes should not break existing users. If the
changes are not
breaking anything then sure, there is no point in doing a release. Waiting
for users
to say it's broken is not a nice option, especially if you know you're
breaking
the plugin. If you do, a better approach is to release the exsiting plugin
and bump
the version number, so that at least existing users can keep the older
plugin.
Not perfect, but will be good when plugins have their own lifecycle and
especially when
users will be able to choose what plugin version to use in their
project.xml!
</p>
</li>
</ul>
</section>
</body>
</document>
1.1 maven/xdocs/reference/developers/ide/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<title>IDE Configuration Documentation</title>
<author email="[EMAIL PROTECTED]">Ben Walding</author>
</properties>
<body>
<section name="IDE Configuration Documentation">
<p>
This document provides an overview of how to configure various IDEs
appropriately for Maven development.
</p>
<ul>
<li><a href="eclipse/index.html">Eclipse 2.1</a></li>
</ul>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
