geronimo-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jb...@apache.org
Subject svn commit: r706724 - /geronimo/site/trunk/JavaDoc.readme
Date Tue, 21 Oct 2008 19:11:41 GMT
Author: jbohn
Date: Tue Oct 21 12:11:41 2008
New Revision: 706724

URL: http://svn.apache.org/viewvc?rev=706724&view=rev
Log:
include updated directions that do not specify including the generated javadoc in svn

Modified:
    geronimo/site/trunk/JavaDoc.readme

Modified: geronimo/site/trunk/JavaDoc.readme
URL: http://svn.apache.org/viewvc/geronimo/site/trunk/JavaDoc.readme?rev=706724&r1=706723&r2=706724&view=diff
==============================================================================
--- geronimo/site/trunk/JavaDoc.readme (original)
+++ geronimo/site/trunk/JavaDoc.readme Tue Oct 21 12:11:41 2008
@@ -6,7 +6,7 @@
 
 1.- Checkout the "tag" you want to generate the javadocs from, for example
 
-	svn co https://svn.apache.org/repos/asf/geronimo/server/tags/2.0.1/  /Apache/tags-2.0.1
+	svn co https://svn.apache.org/repos/asf/geronimo/server/tags/2.1.3/  /Apache/tags-2.1.3
 
 2.- Create a style sheet file with the following content, for example /Apache/apidocs.css
 
@@ -46,7 +46,7 @@
 3.- Generate javadocs with Maven 2 using the following command from the "tags/x.y.z" directory.
     For example:
   
-	/Apache/tags-2.0.1/>mvn javadoc:javadoc -Daggregate=true -Dstylesheetfile="/Apache/apidocs.css"
+	/Apache/tags-2.1.3/>mvn javadoc:javadoc -Daggregate=true -Dstylesheetfile="/Apache/apidocs.css"
 
 4.- The previous command will generate a "target/site/apidocs" directory with all the generated
HTML javadocs.
     On this directory create a "header.html" file with the following content.
@@ -81,7 +81,7 @@
 	<HEAD>
 	<!-- Generated by javadoc on Fri Aug 24 14:10:17 EDT 2007-->
 	    <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-	    <TITLE>Geronimo 2.0.1 API</TITLE>
+	    <TITLE>Geronimo 2.1.3 API</TITLE>
 	    <SCRIPT type="text/javascript">
 		targetPage = "" + window.location.search;
 		if (targetPage != "" && targetPage != "undefined")
@@ -115,10 +115,12 @@
 	</FRAMESET>
 	</HTML>
 
-6.- Create new directory on site trunk for these docs, for example:
+6.- Copy the completed javadoc to /www/geronimo.apache.org  - for example:
 
-	/geronimo/site/trunk/docs/apidocs/2.0.1
+    ssh to people.apache.org
+    cd /www/geronimo.apache.org/docs/apidocs
+    mkdir 2.1.3
 	
     and copy the javadocs you just created there.
 
-7.- Do an svn add of all those files and directories and then commit the changes.
\ No newline at end of file
+7.- As the items are synced with the mirrors it will go live.



Mime
View raw message