README

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 PDF Documentation
--------------------------

If you want to generate PDF from the files in this repository, perform
the following tasks:

  * Make sure that you have Java and ANT installed.

  * Create environment variables for the following:
      DOC_HOME (path to the /content directory), 
      DITA_HOME (path to the /tools/DITA-OT directory)
      JAVA_HOME
      ANT_HOME

  * In the build.properties file for the guide you want to build, make sure that the
    pdf.formatter value is set to fop. The pdf.formatter value for xep should be 
    commented out.

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    pdf.formatter=fop
    #pdf.formatter=xep
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  * Change to the /tools/DITA-OT directory, and 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 the ant command and the output format type:

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    ant pdf
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Building HTML Documentation
---------------------------

If you want to generate HTML from the files in this repository, perform
the following tasks:

  * Make sure that you have Java.

  * Create environment variables for DOC_HOME (path to the /content/ directory
    is), DITAC_HOME (path to the /tools/tools/ditac/ditac-2_2_3 directory), 
    and JAVA_HOME.

  * Open a terminal and run the following command:

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   ( DOC_NAME=ig DOC_VER=3.2;
   $DITAC_HOME/bin/ditac \
    -f webhelp \
    -images img \
    -p use-note-icon yes \
    -p xsl-resources-directory css \
    -toc \
    -p chain-pages both \
    -p wh-jquery-ui ../../jquery-ui/js/jquery-ui-1.8.23.custom.min.js \
    -p wh-jquery-css ../../jquery-ui/css/custom-theme/jquery-ui-1.8.23.custom.css \
    -p wh-user-header ./whc_template/_wh/euca/header_$DOC_NAME.html \
    -p wh-user-resources ./whc_template/_wh/euca \
    -p wh-user-css ./whc_template/_wh/euca/eucadoc.css \
    -p wh-user-footer ./whc_template/_wh/euca/footer.html \
    -p wh-collapse-toc yes \
    -index \
    out/docs/$DOC_VER/$DOC_NAME/_.html \
    $DOC_HOME/en_us/$DOC_NAME.ditamap )
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  * To generate other guides, change the value for DOC_NAME to the initials of the
    guide you want to generate: 
    * ag  - Administration Guide
    * cli - Command Line Reference Guide
    * fs  - FastStart Guide
    * ig  - Installation Guide
    * ug  - User Guide

  * To open the generated set of HTML file, go to:
    $DITAC_HOME/out/docs/3.2/$DOC_NAME/index.html

  * Note that the Eucalyptus logo will not display in your output. You can edit this 
    path or image file by editing each header file located in:
    $DITAC_HOME/whc_template/_wh/euca/header_$DOC_NAME.html

Before You Submit Content
_________________________

Please make sure that your content is valid. If the XML content is not valid,
our build breaks and we get unhappy when our build breaks.

To validate your content:

  * Set up a session variable to point to the DITA-OT catalog file.

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    export SGML_CATALOG_FILES=$DITA_HOME/catalog-dita.xml 
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

  * Run the xmllint command against a file you worked on.

    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    xmllint --noout --valid --catalogs [path_to_the_file] 
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

   If there is a validation error, the command will return the line number and the
   section where the error is located. No output means that there are no errors and
   you can submit content.

  * For more information about xmllint, go to:
    http://xmlsoft.org/xmllint.html