svn commit: r373012 - /directory/trunks/apacheds/site.readme.txt

[er...@apache.org]

Author: ersiner
Date: Fri Jan 27 14:35:50 2006
New Revision: 373012

URL: http://svn.apache.org/viewcvs?rev=373012&view=rev
Log:
Adding site generation and deployment documentation.

Added:
    directory/trunks/apacheds/site.readme.txt

Added: directory/trunks/apacheds/site.readme.txt
URL: http://svn.apache.org/viewcvs/directory/trunks/apacheds/site.readme.txt?rev=373012&view=auto
==============================================================================
--- directory/trunks/apacheds/site.readme.txt (added)
+++ directory/trunks/apacheds/site.readme.txt Fri Jan 27 14:35:50 2006
@@ -0,0 +1,35 @@
+##############  W O R K  I N  P R O G R E S S  ############## 
+
+To generate the whole site for this project execute
+
+	mvn site --non-recursive
+
+The site will be generated at
+
+	target/site
+
+For deploying the site to the remote server you need to
+configure the Apache Web Server access parameters
+in your local m2 configuration file which is normally at
+
+	$HOME/.m2/settings.xml
+
+A typical settings file which contains only this
+configuration would generally look as follows (for UNIX):
+
+	<settings>
+	  <servers>
+	    <server>
+	      <id>apache.websites</id>
+	      <username>YourApacheUserName</username>
+	      <privateKey>$HOME/.ssh/id_rsa</privateKey>
+	      <directoryPermissions>775</directoryPermissions>
+	      <filePermissions>664</filePermissions>
+	    </server>
+	  </servers>
+	</settings>
+
+To deploy the site to remote server execute
+
+	mvn site-deploy --non-recursive
+