openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
1,115 Commits 10 Branches 54 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
8a121c8d17
Go to file
Jenkins 8a121c8d17 Merge "Testing improvements."
2011-12-12 20:46:04 +00:00
docs Adds function to count tab characters in files to run_test.sh. 2011-11-14 23:46:41 -08:00
horizon Merge "Testing improvements." 2011-12-12 20:46:04 +00:00
openstack-dashboard Merging Instances and Volumes into a single panel. 2011-12-10 11:40:58 -08:00
tools Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.bzrignore Re-architects the OpenStack Dashboard for modularity and extensibility. 2011-11-07 12:59:21 -08:00
.gitignore Unit tests shouldn't override template rendering. 2011-11-21 13:06:00 -08:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 2011-08-31 14:41:36 -07:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
README.rst Gave the README an extension that github would recognize and then render. 2011-12-02 12:34:27 -08:00
run_tests.sh Testing improvements. 2011-12-12 11:34:42 -08:00

README.rst

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:

For blueprints and feature specifications:

For issue tracking:

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

  • 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