From e7a0ddf1cbf3a574ac2dea89c5a05162347da229 Mon Sep 17 00:00:00 2001 From: Zara Date: Thu, 18 Feb 2016 14:58:19 +0000 Subject: [PATCH] Update User Docs The old user/operator docs were completely inaccurate. This updates them so that we aren't giving false information. There are still lots of gaps and missing details that should be filled in. Change-Id: I6e387e6846f1f5a29c4de9d83a187abae078396d --- doc/source/install/manual.rst | 22 +++++----------------- 1 file changed, 5 insertions(+), 17 deletions(-) diff --git a/doc/source/install/manual.rst b/doc/source/install/manual.rst index d6f0d461..4019315e 100644 --- a/doc/source/install/manual.rst +++ b/doc/source/install/manual.rst @@ -5,21 +5,10 @@ Installing the API service ========================== -1. At the command line:: - - $ pip install storyboard +1. Install StoryBoard. [TODO: More details] - Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv storyboard - $ pip install storyboard - -2. By default Storyboard will use SQLite driver which is suitable only for - development mode. Storyboard only supports MySQL, to install MySQL driver - execute:: - - $ pip install MySQL-python +2. Storyboard only supports MySQL. Install MySQL. [TODO: details] 3. Edit ``/etc/storyboard/storyboard.conf``. You'll need to modify ``connection`` parameter in the ``[database]`` section. @@ -38,12 +27,11 @@ Installing the API service .. note:: - Is is recommended to use Apache+mod_wsgi for production installation. + It is recommended to use Apache+mod_wsgi for production installation. Installing the Web Client ========================= -Web Client is an all-javascript application. It doesn't require any software to -run. Just grab a tarball from http://tarballs.openstack.org/storyboard-webclient, -unpack it and serve as static files. +Grab a tarball from http://tarballs.openstack.org/storyboard-webclient, unpack +it, and serve as static files.