diff options
author | Duncan McGreggor <duncan@dreamhost.com> | 2011-11-29 14:03:42 -0800 |
---|---|---|
committer | Duncan McGreggor <duncan@dreamhost.com> | 2011-12-02 12:34:27 -0800 |
commit | a9df37828140005f491fce0e26ddd2d8889d4000 (patch) | |
tree | 1206d765cabee69164a1b6ac960e4430a61f25b6 /README.rst | |
parent | eb896725004283ab53047735dcd308fd934acdd7 (diff) | |
download | tuskar-ui-a9df37828140005f491fce0e26ddd2d8889d4000.tar.gz |
Gave the README an extension that github would recognize and then render.
Change-Id: I54fb08b3421b47d98df649d36b9f29726d5aa0ca
Diffstat (limited to 'README.rst')
-rw-r--r-- | README.rst | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..a5c3acb5 --- /dev/null +++ b/README.rst @@ -0,0 +1,75 @@ +OpenStack Dashboard (Horizon) +----------------------------- + +The OpenStack Dashboard is a Django based reference implementation of a web +based management interface for OpenStack. + +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 ``horizon``, see the +README file in the ``horizon`` folder. + +For release management: + + * https://launchpad.net/horizon + +For blueprints and feature specifications: + + * https://blueprints.launchpad.net/horizon + +For issue tracking: + + * https://bugs.launchpad.net/horizon + + +Project Structure and Testing: +------------------------------ + +This project is a bit different from other OpenStack projects in that it has +two very distinct components underneath it: ``horizon``, and +``openstack-dashboard``. + +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. + +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 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:: + + $ ./run_tests.sh + +Building Contributor Documentation +---------------------------------- + +This documentation is written by contributors, for contributors. + +The source is maintained in the ``docs/source`` folder using +`reStructuredText`_ and built by `Sphinx`_ + +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _Sphinx: http://sphinx.pocoo.org/ + +* Building Automatically:: + + $ ./run_tests.sh --docs + +* Building Manually:: + + $ export DJANGO_SETTINGS_MODULE=local.local_settings + $ python doc/generate_autodoc_index.py + $ sphinx-build -b html doc/source build/sphinx/html + +Results are in the `build/sphinx/html` directory |