tuskar-ui/docs/source/index.rst
Gabriel Hurley aca739445e Refactored test suite.
* Moves all tests to use a single set of central test data and
    Adds a nifty manager for it.
    Implements blueprint unified-test-data.

  * Cleans up API code and API tests so that we're not testing
    code that has no custom logic, or wrapping objects unnecessarily.
    Implements blueprint api-simplification.

  * Adds lots of docs on testing. It's a good step towards
    blueprint improve-dev-documentation.

  * Improves API exception handling for duplicate objects and containers.
    Fixes bug 930816.

Change-Id: I5526ccf5b38708885ea2d1f06b0d3483c58c4dad
2012-02-13 15:24:06 -08:00

117 lines
2.4 KiB
ReStructuredText

..
Copyright 2012 OpenStack, LLC
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
========================================
Horizon: The OpenStack Dashboard Project
========================================
Introduction
============
Horizon is the canonical implementation of `Openstack's Dashboard
<https://github.com/openstack/horizon>`_, which provides a web based user
interface to OpenStack services including Nova, Swift, Keystone, etc.
For a more in-depth look at Horizon and its architecture, see the
:doc:`Introduction to Horizon <intro>`.
To learn what you need to know to get going, see the :doc:`quickstart`.
Getting Started With Horizon
============================
How to use Horizon in your own projects.
.. toctree::
:maxdepth: 1
intro
quickstart
topics/branding
Developer Docs
==============
For those wishing to develop Horizon itself, or go in-depth with building
your own :class:`~horizon.Dashboard` or :class:`~horizon.Panel` classes,
the following documentation is provided.
General information
-------------------
Brief guides to areas of interest and importance when developing Horizon.
.. toctree::
:maxdepth: 1
contributing
testing
Topic Guides
------------
Information on how to work with specific areas of Horizon can be found in
the following topic guides.
.. toctree::
:maxdepth: 1
topics/tables
topics/testing
API Reference
-------------
In-depth documentation for Horizon and it's APIs.
.. toctree::
:maxdepth: 1
ref/run_tests
ref/horizon
ref/tables
ref/users
ref/forms
ref/views
ref/middleware
ref/context_processors
ref/decorators
ref/exceptions
ref/test
Source Code Reference
---------------------
Auto-generated reference for the complete source code.
.. toctree::
:maxdepth: 1
sourcecode/autoindex
Information
===========
.. toctree::
:maxdepth: 1
faq
glossary
* :ref:`genindex`
* :ref:`modindex`