371f4638dd
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: b'https://gist.github.com/2b00c35799734733ecdec861c74975d8\n' Change-Id: If27279ec325cefdf713dc924617429afc0834c87
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 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
|
|
|
|
.. image:: http://governance.openstack.org/badges/horizon.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
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
|