Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 137 lines (103 sloc) 5.242 kb
c0db819 @neilsoman renamed to README
neilsoman 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
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
25 Building PDF Documentation
26 --------------------------
c0db819 @neilsoman renamed to README
neilsoman authored
27
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
28 If you want to generate PDF from the files in this repository, perform
c0db819 @neilsoman renamed to README
neilsoman authored
29 the following tasks:
30
ec39860 @noirin Updating instructions to match what worked for Harold and me earlier
noirin authored
31 * Make sure that you have Java and ANT installed.
c0db819 @neilsoman renamed to README
neilsoman authored
32
ec39860 @noirin Updating instructions to match what worked for Harold and me earlier
noirin authored
33 * Create environment variables for the following:
34 DOC_HOME (path to the /content directory),
35 DITA_HOME (path to the /tools/DITA-OT directory)
36 JAVA_HOME
37 ANT_HOME
c0db819 @neilsoman renamed to README
neilsoman authored
38
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
39 * In the build.properties file for the guide you want to build, make sure that the
40 pdf.formatter value is set to fop. The pdf.formatter value for xep should be
41 commented out.
c0db819 @neilsoman renamed to README
neilsoman authored
42
43 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44 pdf.formatter=fop
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
45 #pdf.formatter=xep
c0db819 @neilsoman renamed to README
neilsoman authored
46 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
47
ec39860 @noirin Updating instructions to match what worked for Harold and me earlier
noirin authored
48 * Change to the /tools/DITA-OT directory, and run the shell script
49 DITA-OT/startcmd.sh (or startcmd.bat in Windows) to set up the necessary
50 environment variables.
c0db819 @neilsoman renamed to README
neilsoman authored
51
52 * In the same shell window, change directories to the directory you want to
53 generate documentation for.
54
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
55 * Enter the ant command and the output format type:
c0db819 @neilsoman renamed to README
neilsoman authored
56
57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58 ant pdf
59 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
cb81ecd @smarvin DOC-571: Edited file for HTML building directions.
smarvin authored
60
61 Building HTML Documentation
62 ---------------------------
63
64 If you want to generate HTML from the files in this repository, perform
65 the following tasks:
66
67 * Make sure that you have Java.
68
69 * Create environment variables for DOC_HOME (path to the /content/ directory
70 is), DITAC_HOME (path to the /tools/tools/ditac/ditac-2_2_3 directory),
71 and JAVA_HOME.
72
73 * Open a terminal and run the following command:
74
75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76 ( DOC_NAME=ig DOC_VER=3.2;
77 $DITAC_HOME/bin/ditac \
78 -f webhelp \
79 -images img \
80 -p use-note-icon yes \
81 -p xsl-resources-directory css \
82 -toc \
83 -p chain-pages both \
84 -p wh-jquery-ui ../../jquery-ui/js/jquery-ui-1.8.23.custom.min.js \
85 -p wh-jquery-css ../../jquery-ui/css/custom-theme/jquery-ui-1.8.23.custom.css \
86 -p wh-user-header ./whc_template/_wh/euca/header_$DOC_NAME.html \
87 -p wh-user-resources ./whc_template/_wh/euca \
88 -p wh-user-css ./whc_template/_wh/euca/eucadoc.css \
89 -p wh-user-footer ./whc_template/_wh/euca/footer.html \
90 -p wh-collapse-toc yes \
91 -index \
92 out/docs/$DOC_VER/$DOC_NAME/_.html \
93 $DOC_HOME/en_us/$DOC_NAME.ditamap )
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
95
96 * To generate other guides, change the value for DOC_NAME to the initials of the
97 guide you want to generate:
98 * ag - Administration Guide
99 * cli - Command Line Reference Guide
100 * fs - FastStart Guide
101 * ig - Installation Guide
102 * ug - User Guide
103
104 * To open the generated set of HTML file, go to:
105 $DITAC_HOME/out/docs/3.2/$DOC_NAME/index.html
106
107 * Note that the Eucalyptus logo will not display in your output. You can edit this
108 path or image file by editing each header file located in:
109 $DITAC_HOME/whc_template/_wh/euca/header_$DOC_NAME.html
110
de2c695 @smarvin Updating readme with instructions for validating content.
smarvin authored
111 Before You Submit Content
112 _________________________
113
114 Please make sure that your content is valid. If the XML content is not valid,
115 our build breaks and we get unhappy when our build breaks.
116
117 To validate your content:
118
119 * Set up a session variable to point to the DITA-OT catalog file.
120
121 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
122 export SGML_CATALOG_FILES=$DITA_HOME/catalog-dita.xml
123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
124
125 * Run the xmllint command against a file you worked on.
126
127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128 xmllint --noout --valid --catalogs [path_to_the_file]
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
130
131 If there is a validation error, the command will return the line number and the
132 section where the error is located. No output means that there are no errors and
3f8d93b @smarvin Adding link for more info about xmllint.
smarvin authored
133 you can submit content.
134
135 * For more information about xmllint, go to:
ec39860 @noirin Updating instructions to match what worked for Harold and me earlier
noirin authored
136 http://xmlsoft.org/xmllint.html
Something went wrong with that request. Please try again.