Merge "Clean up doc/ and releasenotes/"

doc/source/index.rst

@@ -1,60 +1,28 @@
-===============================
-zaqar-ui
-===============================
+========
+Zaqar UI
+========
 
-Zaqar Dashboard
+Horizon plugin for Zaqar
 
 * Free software: Apache license
 * Source: http://git.openstack.org/cgit/openstack/zaqar-ui
 * Bugs: http://bugs.launchpad.net/zaqar-ui
 
-Installation instructions
-=========================
-
-Begin by cloning the Horizon and Zaqar UI repositories::
-
-    git clone https://github.com/openstack/horizon
-    git clone https://github.com/openstack/zaqar-ui
-
-Create a virtual environment and install Horizon dependencies::
-
-    cd horizon
-    python tools/install_venv.py
-
-Set up your ``local_settings.py`` file::
-
-    cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
-
-Open up the copied ``local_settings.py`` file in your preferred text
-editor. You will want to customize several settings:
-
--  ``OPENSTACK_HOST`` should be configured with the hostname of your
-   OpenStack server. Verify that the ``OPENSTACK_KEYSTONE_URL`` and
-   ``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
-   environment. (They should be correct unless you modified your
-   OpenStack server to change them.)
-
-
-Install Zaqar UI with all dependencies in your virtual environment::
-
-    tools/with_venv.sh pip install -e ../zaqar-ui/
-
-And enable it in Horizon::
-
-    cp ../zaqar-ui/enabled/_1510_messaging_panel_group.py openstack_dashboard/local/enabled
-    cp ../zaqar-ui/enabled/_1520_zaqar_project_queues.py openstack_dashboard/local/enabled
-
-Release Notes
-=============
+Usage
+-----
 
 .. toctree::
-  :glob:
   :maxdepth: 1
 
-  releases/*
+  install
+
+Release Notes
+-------------
+
+* https://docs.openstack.org/releasenotes/zaqar-ui
 
 Source Code Reference
-=====================
+---------------------
 
 .. toctree::
   :glob:

doc/source/install.rst

@@ -0,0 +1,47 @@
+============
+Installation
+============
+
+Enabling in DevStack
+--------------------
+
+Add this repo as an external repository into your ``local.conf`` file::
+
+    [[local|localrc]]
+    enable_plugin zaqar-ui https://github.com/openstack/zaqar-ui
+
+Manual Installation
+-------------------
+
+Begin by cloning the Horizon and Zaqar UI repositories::
+
+    git clone https://github.com/openstack/horizon
+    git clone https://github.com/openstack/zaqar-ui
+
+Create a virtual environment and install Horizon dependencies::
+
+    cd horizon
+    python tools/install_venv.py
+
+Set up your ``local_settings.py`` file::
+
+    cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py
+
+Open up the copied ``local_settings.py`` file in your preferred text
+editor. You will want to customize several settings:
+
+-  ``OPENSTACK_HOST`` should be configured with the hostname of your
+   OpenStack server. Verify that the ``OPENSTACK_KEYSTONE_URL`` and
+   ``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
+   environment. (They should be correct unless you modified your
+   OpenStack server to change them.)
+
+
+Install Zaqar UI with all dependencies in your virtual environment::
+
+    tools/with_venv.sh pip install -e ../zaqar-ui/
+
+And enable it in Horizon::
+
+    cp ../zaqar-ui/enabled/_1510_messaging_panel_group.py openstack_dashboard/local/enabled
+    cp ../zaqar-ui/enabled/_1520_zaqar_project_queues.py openstack_dashboard/local/enabled

doc/source/releases/0.1.0.rst

@@ -1,2 +0,0 @@
-Zaqar UI 0.1.0
-===============

releasenotes/source/conf.py

@@ -40,7 +40,7 @@ extensions = [
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+# templates_path = ['_templates']
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -138,7 +138,7 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied