Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 55 lines (39 sloc) 2.136 kB
c0db819 renamed to README
Neil Soman authored
1 Welcome
2 -------
3
4 This repository contains the installation, administration, user, and reference
5 documentation for Eucalyptus. It includes files for generating guides published
6 on the Eucalyptus website (www.eucalyptus.com).
7
8 Contributing to Eucalyptus
9 --------------------------
10
11 Eucalyptus welcomes all people interested in cloud computing. We recommend that
12 you connect with other Eucalyptus users or get actively involved with Eucalyptus
13 development, including documentation.
14
15 The Eucalyptus IRC channel is #eucalyptus on Freenode. This channel is used for
16 real-time communication among users and developers. Information about how to use
17 the network is available from Freenode
18 (http://freenode.net/using_the_network.shtml).
19
20 The Eucalyptus community mailing list is community@lists.eucalyptus.com. This
21 list is used for user discussions, problem reports, and other communications.
22 Information about how to subscribe is available at
23 http://lists.eucalyptus.com/cgi-bin/mailman/listinfo/community.
24
25 Building Documentation
26 ----------------------
27
28 If you want to generate HTML or PDF from the files in this repository, perform
29 the following tasks:
30
31 * Make sure that you have Java and ANT.
32
33 * Create environment variables for DOC_HOME (path to where the euca directory
34 is), DITA_HOME (path to the euca/DITA-OT directory), JAVA_HOME, and
35 ANT_HOME.
36
37 * In the build.properties file for the guide you want to build, change the
38 pdf.formatter value from xep to fop:
39
40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41 pdf.formatter=fop
42 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
43
44 * Run the shell script DITA-OT/startcmd.sh (or startcmd.bat in Windows) to set
45 up the necessary environment variables.
46
47 * In the same shell window, change directories to the directory you want to
48 generate documentation for.
49
50 * Enter ant and the type of output you want (pdf or xhtml):
51
52 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53 ant pdf
54 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Something went wrong with that request. Please try again.