horizon/README.rst
Akihiro Motoki aa0f0ebc18 Add install guide for users and clean up README
* Add "Using Horizon" section to the docs, which describes
  how to install and configure Horizon. It is for operators
  who install Horizon from source code.
* Clean up README.rst as much of the information is out-of-date
  and most of it is covered by the developer docs.
* Minor update of page titles.

Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-09 03:29:26 +09:00

52 lines
1.7 KiB
ReStructuredText

=============================
Horizon (OpenStack Dashboard)
=============================
Horizon is a Django-based project aimed at providing a complete OpenStack
Dashboard along with an extensible framework for building new dashboards
from reusable components. The ``openstack_dashboard`` module is a reference
implementation of a Django site that uses the ``horizon`` app to provide
web-based interactions with the various OpenStack projects.
* Release management: https://launchpad.net/horizon
* Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
* Issue tracking: https://bugs.launchpad.net/horizon
Using Horizon
=============
See ``doc/source/topics/install.rst`` about how to install Horizon
in your OpenStack setup. It describes the example steps and
has pointers for more detailed settings and configurations.
It is also available at http://docs.openstack.org/developer/horizon/topics/install.html.
Getting Started for Developers
==============================
``doc/source/quickstart.rst`` or
http://docs.openstack.org/developer/horizon/quickstart.html
describes how to setup Horizon development environment and start development.
Building Contributor Documentation
==================================
This documentation is written by contributors, for contributors.
The source is maintained in the ``doc/source`` directory using
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
* Building Automatically::
$ ./run_tests.sh --docs
* Building Manually::
$ tools/with_venv.sh sphinx-build doc/source doc/build/html
Results are in the ``doc/build/html`` directory