summaryrefslogtreecommitdiff
path: root/docs/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst101
1 files changed, 101 insertions, 0 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 00000000..c326d6de
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,101 @@
+..
+ Copyright 2011 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 it's 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
+
+
+Developer Reference
+===================
+
+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.
+
+Topics
+------
+
+Brief guides to areas of interest and importance when developing Horizon.
+
+.. toctree::
+ :maxdepth: 1
+
+ testing
+
+API Reference
+-------------
+
+In-depth documentation for Horizon and it's APIs.
+
+.. toctree::
+ :maxdepth: 1
+
+ ref/run_tests
+ ref/horizon
+ ref/users
+ ref/forms
+ ref/views
+ ref/middleware
+ ref/context_processors
+ ref/decorators
+ ref/exceptions
+
+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`