Skip to content

Commit

Permalink
Adding a README, config options, and ha admin
Browse files Browse the repository at this point in the history
  • Loading branch information
adamhjk committed Feb 27, 2012
1 parent e49e473 commit 6b9a73c
Show file tree
Hide file tree
Showing 8 changed files with 6,472 additions and 8 deletions.
36 changes: 36 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Private Chef Administration Guide

This repository has the source material for the Private Chef Administration guide.

## Prerequisites

To use this documentation, you'll need to have [Sphinx](http://sphinx.pocoo.org) installed,
along with [Pygments](http://pygments.org) for syntax highlighting. If you want to generate
PDF documentation, you'll also need to have a version of [LaTeX](http://www.latex-project.org/)
installed (specifically latex2pdf).

## Installation

```bash
$ easy_install Pygments
$ easy_install sphinx
```

## Build

To build the documentation:

```bash
$ make html
```

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

Run:

```bash
$ make help
```

For alternative formats.

Binary file added assets/ha-topology.graffle
Binary file not shown.
1 change: 1 addition & 0 deletions source/administration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ This section will guide you through the most common administrative tasks associa

.. toctree::

administration/configuration
administration/private_chef_ctl
administration/logs
administration/user_management
Expand Down
Loading

0 comments on commit 6b9a73c

Please sign in to comment.