forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: r178242 - /forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml /forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml
Date Tue, 24 May 2005 18:49:43 GMT
Author: rgardler
Date: Tue May 24 11:49:42 2005
New Revision: 178242

URL: http://svn.apache.org/viewcvs?rev=178242&view=rev
Log:
created basic docs for building release notes

Modified:
    forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
    forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml

Modified: forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml?rev=178242&r1=178241&r2=178242&view=diff
==============================================================================
--- forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
(original)
+++ forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/src/documentation/content/xdocs/index.xml
Tue May 24 11:49:42 2005
@@ -30,8 +30,33 @@
       <ul>
         <li><a href="changes.html">Recent Changes</a></li>
         <li><a href="todo.html">ToDo list</a></li>
-        <li><a href="releaseNotes_0.1">Release Notes</a></li>
+        <li><a href="releaseNotes_0.1.html">Release Notes</a></li>
       </ul>
+    </section>
+    
+    <section>
+      <title>Producing Release Notes</title>
+      <p>To produce release notes you must maintain a <code>status.xml</code>
file
+      for your project and request a page with an URL such as 
+      <code>http://domain.com/releaseNotes_0.7-dev.html</code>, this will be
produce
+      the release notes for 0.7-dev.</p>
+      
+      <p>If the version number ends with <code>-dev</code> a warning will
be included 
+      in the generated page informing the reader that it is a development version and
+      therefore the list of changes is incomplete.</p>
+
+      <p>For a <code>status.xml</code> <code>action</code>
toi be included in the 
+      release notes it must have an attribute <code>importance="high"</code>.
When
+      writing actions in <code>status.xml</code> you should write them with the
+      following two questions in mind:</p>
+
+      <ul>
+        <li>should it be importance="high"?</li>
+        <li>will the action read correctly in the release notes?</li>
+      </ul>
+      
+      <p>The introductory text in the release notes comes from the (optional) 
+      element <code>notes</code> (a child of the <code>release</code>
element).</p>
     </section>
   </body>
 </document>

Modified: forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml?rev=178242&r1=178241&r2=178242&view=diff
==============================================================================
--- forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml (original)
+++ forrest/trunk/plugins/org.apache.forrest.plugin.input.projectInfo/status.xml Tue May 24
11:49:42 2005
@@ -24,7 +24,20 @@
 
   <changes>
     <!-- Add new releases here -->
-    <release version="0.1" date="unreleased">
+    <release version="0.1" date="25 May 2005">
+      <notes>
+        <p>This plugin encapsulates and extends functionality that was originally in
+        Forrest Core. With the advent of plugins in Forrest 0.7 we extracted the
+        functionlaity for generating changes.xml and todo.xml from status.xml. It is 
+        intended that this functionlaity be extended further within this plugin.</p>
+        
+        <p>In fact, we have already extended the functionaliy in a couple of important
+        ways. See the changelog for more details.</p>
+      </notes>
+      <action context="docs" type="add" dev="RDG" importance="high">
+        Basic documentation on how to create release notes are now included on the
+        plugins documentation index page.
+      </action>
       <action context="code" type="add" dev="RDG" importance="high">
         Added automatic generation of release notes by requesting  **/releaseNotes_VERSION-NUMBER.xml
       </action>



Mime
View raw message