Merge "Updated documentation"

README.rst

@@ -1,35 +1,47 @@
-=================
-CloudKitty panels
-=================
+====================
+CloudKitty dashboard
+====================
 
 :Wiki: `CloudKitty Wiki`_
 :IRC: #cloudkitty @ freenode
 
-Horizon plugin for CloudKitty.
+Horizon dashboard for CloudKitty.
 
 
 .. _CloudKitty Wiki: https://wiki.openstack.org/wiki/CloudKitty
 
 
-Status
-======
+About
+-----
 
-This project is **highly** work in progress.
+cloudkitty-dashboard is an extension for OpenStack Dashboard providing UI for
+CloudKitty.
+
+With CloudKitty dashboard, operators can easily define a rating policy for
+their cloud without the use of a CLI.
+Users can get information about their usage, and predict costs of an instance.
 
 
-cloudkitty-dashboard
-====================
+Contributing
+------------
 
-cloudkitty-dashboard is an extension for OpenStack Dashboard that provides UI
-for CloudKitty. With cloudkitty-dashboard, the user is able to easily manage
-and control rating information thanks to the 2 panels and add-ons in creating
-process.
+We are welcoming new contributors, if you've got new ideas, suggestions or want
+to contribute, contact us.
+
+You can reach us throught IRC (#cloudkitty @freenode.net), or on the official
+OpenStack mailing list openstack-dev@lists.openstack.org.
+
+A launchpad_ project is available if you need to report bugs.
 
 
-Roadmap
-=======
+Trying it
+---------
 
-* Create more add-ons.
-* Save the amount of months.
-* Display graphs with the total amount per month.
-* Add some tests
+CloudKitty can be deployed with devstack, more information can be found in the
+`devstack section`_ of the documentation.
+
+
+.. _launchpad: https://launchpad.net/cloudkitty
+
+
+.. _devstack section: https://cloudkitty.readthedocs.org/en/latest/devstack.html

doc/source/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to cloudkitty-dashboard's documentation!
-========================================================
+Welcome to the cloudkitty-dashboard's documentation!
+====================================================
 
 Contents:
 
@@ -13,7 +13,6 @@ Contents:
 
    readme
    installation
-   usage
    contributing
 
 Indices and tables

doc/source/installation.rst

@@ -2,11 +2,41 @@
 Installation
 ============
 
-At the command line::
+Retrieve and install CloudKitty dashboard:
 
-    $ pip install cloudkitty-dashboard
+::
 
-Or, if you have virtualenvwrapper installed::
+    git clone git://git.openstack.org/openstack/cloudkitty-dashboard
+    cd cloudkitty-dashboard
+    python setup.py install
 
-    $ mkvirtualenv cloudkitty-dashboard
-    $ pip install cloudkitty-dashboard
+
+Find where the python packages are installed:
+
+::
+
+    PY_PACKAGES_PATH=`pip --version | cut -d' ' -f4`
+
+
+Then add the additional settings file to the horizon settings or installation.
+Depending on your setup, you might need to add it to ``/usr/share`` or directly
+in the horizon python package:
+
+::
+
+    # If horizon is installed by packages:
+    ln -s $PY_PACKAGES_PATH/cloudkittydashboard/enabled/_[0-9]*.py \
+    /usr/share/openstack-dashboard/openstack_dashboard/enabled/
+
+    # Directly from sources:
+    ln -s $PY_PACKAGES_PATH/cloudkittydashboard/enabled/_[0-9]*.py \
+    $PY_PACKAGES_PATH/openstack_dashboard/enabled/
+
+
+Restart the web server hosting Horizon.
+
+For more detailed information about CloudKitty installation check out the
+`installation section`_ of the documentation.
+
+
+.. _installation section: https://cloudkitty.readthedocs.org/en/latest/installation.html

doc/source/usage.rst

@@ -1,7 +0,0 @@
-========
-Usage
-========
-
-To use cloudkitty-dashboard in a project::
-
-    import cloudkittydashboard