k-stailey/openstack-chef-docs

Documentation for the Chef for OpenStack project

Chef for OpenStack Guide

This repository has the source material for the Chef for OpenStack Guide.

There will be a permanent URL for the docs online soon, here is a temporary address: http://15.185.230.54/

Prerequisites

To use this documentation, you'll need to have Sphinx installed, along with Pygments for syntax highlighting. If you want to generate PDF documentation, you'll also need to have a version of LaTeX installed (specifically latex2pdf).

Installation

    easy_install Pygments
    easy_install sphinx

Build

To build the documentation:

    export LC_ALL=en_US.UTF
    export LANG=en_US.UTF-8
    make html

Will generate HTML output in build/html/index.html.

Run:

    make help

For alternative formats.

Publish

Use 'make upload' to upload to s3. Requires that you have credentials configured for s3cmd.

OSX Instructions

Using Homebrew Python and avoiding permission issues

    brew install python

Now add the following to your PATH using the shell initialization script that makes sense for your environment:

   export PATH=/usr/local/share/pythno:$PATH

You can now call easy_install directly with no sudo and then follow the make instructions.

Using Python shipped with OSX

A few minor nits for installing on OSX.

    sudo easy_install Pygments
    sudo easy_install sphinx

You may have issues with ownership of /Library/Python/2.7/site-packages/ after you build Pygments and sphinx. You can either change the ownership with:

    sudo chown YOURUSER -R /Library/Python/2.7/site-packages

or make them world-executable with

    sudo chmod -R 755 /Library/Python/2.7/site-packages

You can then use the make commands as previously documented.

iPad

If you want iPad-readable docs, take the output of

    make epub

and copy the build/epub/OpenStackChefGuide.epub to iTunes and sync it into the iBooks app.