horizon/README.rst

51 lines
1.8 KiB
ReStructuredText
Raw Normal View History

=============================
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.
2011-06-17 23:35:00 -07:00
* Release management: https://launchpad.net/horizon
* Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
* Issue tracking: https://bugs.launchpad.net/horizon
2011-06-17 23:35:00 -07:00
.. image:: https://governance.openstack.org/tc/badges/horizon.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
2011-06-17 23:35:00 -07:00
Using Horizon
=============
2011-06-17 23:35:00 -07:00
See ``doc/source/install/index.rst`` about how to install Horizon
in your OpenStack setup. It describes the example steps and
has pointers for more detailed settings and configurations.
2011-06-17 23:35:00 -07:00
It is also available at
`Installation Guide <https://docs.openstack.org/horizon/latest/install/index.html>`_.
2011-06-17 23:35:00 -07:00
Getting Started for Developers
==============================
``doc/source/quickstart.rst`` or
`Quickstart Guide <https://docs.openstack.org/horizon/latest/contributor/quickstart.html>`_
describes how to setup Horizon development environment and start development.
2011-10-27 10:52:33 -07:00
Building Contributor Documentation
==================================
2011-10-27 10:52:33 -07:00
This documentation is written by contributors, for contributors.
The source is maintained in the ``doc/source`` directory using
2011-10-27 10:52:33 -07:00
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org/
2011-10-27 10:52:33 -07:00
To build the docs, use::
2011-10-27 10:52:33 -07:00
$ tox -e docs
2011-10-27 10:52:33 -07:00
Results are in the ``doc/build/html`` directory