summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGabriel Hurley <gabriel@strikeawe.com>2011-10-31 11:31:05 -0700
committerGabriel Hurley <gabriel@strikeawe.com>2011-11-07 12:59:21 -0800
commit9742842795e964c7f260aec831665d5cb28cd420 (patch)
treeaa7de5eb8efbdaa466c4b3ce4f1f5f48517936d5 /README
parent91ceb59bae8818e407614bb0ff32f21ced1eadaa (diff)
downloadtuskar-ui-9742842795e964c7f260aec831665d5cb28cd420.tar.gz
Re-architects the OpenStack Dashboard for modularity and extensibility.
Implements blueprint extensible-architecture. Implements blueprint improve-dev-documentation. Implements blueprint gettext-everywhere. Implements blueprint sphinx-docs. Complete re-architecture of the dashboard to transform it from a standalone django-openstack app to a Horizon framework for building dashboards. See the docs for more information. Incidentally fixes the following bugs: Fixes bug 845868 -- no PEP8 violations. Fixes bug 766096 -- the dashboard can now be installed at any arbitrary URL. Fixes bug 879111 -- tenant id is now controlled solely by the tenant switcher, not the url (which was disregarded anyway) Fixes bug 794754 -- output of venv installation is considerably reduced. Due to the scale and scope of this patch I recommend reviewing it on github: https://github.com/gabrielhurley/horizon/tree/extensible_architecture Change-Id: I8e63f7ea235f904247df40c33cb66338d973df9e
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 17 insertions, 17 deletions
diff --git a/README b/README
index edbfb156..2492bc59 100644
--- a/README
+++ b/README
@@ -4,14 +4,14 @@ OpenStack Dashboard (Horizon)
The OpenStack Dashboard is a Django based reference implementation of a web
based management interface for OpenStack.
-It is based on django-openstack, which is designed to be a generic Django
-module that can be re-used in other sites.
+It is based on the ``horizon`` module, which is designed to be a generic Django
+app that can be re-used in other projects.
For more information about how to get started with the OpenStack Dashboard,
view the README file in the openstack-dashboard folder.
-For more information about working directly with django-openstack, see the
-README file in the django-openstack folder.
+For more information about working directly with ``horizon``, see the
+README file in the ``horizon`` folder.
For release management:
@@ -29,21 +29,21 @@ Project Structure and Testing:
------------------------------
This project is a bit different from other Openstack projects in that it has
-two very distinct components underneath it: django-openstack, and
-openstack-dashboard.
+two very distinct components underneath it: ``horizon``, and
+``openstack-dashboard``.
-django-openstack holds the generic libraries and components that can be
-used in any Django project. In testing, this component is set up with
-buildout (see run_tests.sh), and any dependencies that get added need to
-be added to the django-openstack/buildout.cfg file.
+The ``horizon`` directory holds the generic libraries and components that can
+be used in any Django project. In testing, this component is set up with
+buildout (see ``run_tests.sh``), and any dependencies that get added need to
+be added to the ``horizon/buildout.cfg`` file.
-openstack-dashboard is a reference django project that uses django-openstack
-and is built with a virtualenv and tested through that environment. If
-depdendencies are added that the reference django project needs, they
-should be added to openstack-dashboard/tools/pip-requires.
+The ``openstack-dashboard`` directory contains a reference Django project that
+uses ``horizon`` and is built with a virtualenv and tested through that
+environment. If dependencies are added that ``openstack-dashboard`` requires
+they should be added to ``openstack-dashboard/tools/pip-requires``.
-The run_tests.sh script invokes tests and analysis on both of these
-components in it's process, and is what Jenkins uses to verify the
+The ``run_tests.sh`` script invokes tests and analyses on both of these
+components in its process, and is what Jenkins uses to verify the
stability of the project.
To run the tests::
@@ -55,7 +55,7 @@ Building Contributor Documentation
This documentation is written by contributors, for contributors.
-The source is maintained in the `doc/source` folder using
+The source is maintained in the ``docs/source`` folder using
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html