Tom Fifield 2f42739033 Add firstapp sec2&3 for fog
Adds section 2 and 3 for the fog SDK for FirstApp tutorial,
as well as fixes the repo that the faafo is cloned from
in section 1.

Co-Author: Caleb Boylan <calebboylan@gmail.com>
Co-Author: Tom Fifield <tom@openstack.org>

Partial-Bug: #1449329

Change-Id: I553af22e904261d3465eda4301a664d24fe91b31
2015-11-17 15:10:02 +08:00
..
2015-11-17 15:10:02 +08:00
2015-11-17 15:10:02 +08:00

Writing Your First OpenStack Application

This directory contains the "Writing Your First OpenStack Application" tutorial.

The tutorials work with an application that can be found in the openstack/faafo repository.

Prerequisites

To build the documentation, you must install the Graphviz package.

/source

The /source directory contains the tutorial documentation as reStructuredText (RST).

To build the documentation, you must install Sphinx and the OpenStack docs.openstack.org Sphinx theme (openstackdocstheme). When you invoke tox, these dependencies are automatically pulled in from the top-level test-requirements.txt.

You must also install Graphviz on your build system.

The RST source includes conditional output logic. The following command invokes sphinx-build with -t libcloud:

tox -e firstapp-libcloud

Only the sections marked .. only:: libcloud in the RST are built.

/samples

The code samples in this guide are located in this directory. The code samples for each SDK are located in separate subdirectories.

/build-libcloud

The HTML documentation is built in this directory. The .gitignore file for the project specifies this directory.