Skip to content
Browse files

renamed to README

  • Loading branch information...
1 parent b336f18 commit c0db81900dd20f83a5e4f34e84ebac8f4fdb36a5 Neil Soman committed May 23, 2012
Showing with 54 additions and 0 deletions.
  1. +54 −0 README
View
54 README
@@ -0,0 +1,54 @@
+Welcome
+-------
+
+This repository contains the installation, administration, user, and reference
+documentation for Eucalyptus. It includes files for generating guides published
+on the Eucalyptus website (www.eucalyptus.com).
+
+Contributing to Eucalyptus
+--------------------------
+
+Eucalyptus welcomes all people interested in cloud computing. We recommend that
+you connect with other Eucalyptus users or get actively involved with Eucalyptus
+development, including documentation.
+
+The Eucalyptus IRC channel is #eucalyptus on Freenode. This channel is used for
+real-time communication among users and developers. Information about how to use
+the network is available from Freenode
+(http://freenode.net/using_the_network.shtml).
+
+The Eucalyptus community mailing list is community@lists.eucalyptus.com. This
+list is used for user discussions, problem reports, and other communications.
+Information about how to subscribe is available at
+http://lists.eucalyptus.com/cgi-bin/mailman/listinfo/community.
+
+Building Documentation
+----------------------
+
+If you want to generate HTML or PDF from the files in this repository, perform
+the following tasks:
+
+ * Make sure that you have Java and ANT.
+
+ * Create environment variables for DOC_HOME (path to where the euca directory
+ is), DITA_HOME (path to the euca/DITA-OT directory), JAVA_HOME, and
+ ANT_HOME.
+
+ * In the build.properties file for the guide you want to build, change the
+ pdf.formatter value from xep to fop:
+
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ pdf.formatter=fop
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+ * Run the shell script DITA-OT/startcmd.sh (or startcmd.bat in Windows) to set
+ up the necessary environment variables.
+
+ * In the same shell window, change directories to the directory you want to
+ generate documentation for.
+
+ * Enter ant and the type of output you want (pdf or xhtml):
+
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ ant pdf
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 comments on commit c0db819

Please sign in to comment.
Something went wrong with that request. Please try again.