opendev/storyboard
Code Issues Proposed changes

Update User Docs

Browse Source 
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
This commit is contained in:
Zara 2016-02-18 14:58:19 +00:00
parent 51f8bc0277
commit e7a0ddf1cb
1 changed files with 5 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/install/manual.rst
View File

@ -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.