rearrange content into the new standard layout

Change-Id: I6dbe0ea81d9d21a0f92d270337637606220f38d1
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

doc/source/contributor/contributing.rst

@@ -23,7 +23,7 @@ Getting Started
 ---------------
 
 We'll start by assuming you've got a working checkout of the repository (if
-not then please see the :doc:`quickstart`).
+not then please see the :ref:`quickstart`).
 
 Second, you'll need to take care of a couple administrative tasks:
 
@@ -353,7 +353,7 @@ AngularJS
 .. Note::
 
   This section is intended as a quick intro to contributing with AngularJS. For
-  more detailed information, check the :doc:`topics/angularjs`.
+  more detailed information, check the :ref:`topics-angularjs`.
 
 "John Papa Style Guide"
 ~~~~~~~~~~~~~~~~~~~~~~~

doc/source/contributor/faq.rst

@@ -1,3 +1,5 @@
+.. _faq:
+
 ==========================
 Frequently Asked Questions
 ==========================

doc/source/contributor/index.rst

@@ -0,0 +1,16 @@
+===========================
+ Contributor Documentation
+===========================
+
+
+.. toctree::
+   :maxdepth: 2
+
+   intro
+   quickstart
+   contributing
+   testing
+   tutorials/index
+   topics/index
+   ref/index
+   faq

doc/source/contributor/intro.rst

@@ -1,3 +1,5 @@
+.. _contributor-intro:
+
 ==============
 Horizon Basics
 ==============
@@ -111,11 +113,11 @@ on the best possible experience.
 
 .. seealso::
 
-    :doc:`Quickstart <quickstart>`
+    :ref:`quickstart`
         A short guide to getting started with using Horizon.
 
-    :doc:`Frequently Asked Questions <faq>`
+    :ref:`faq`
         Common questions and answers.
 
-    :doc:`Glossary <glossary>`
+    :ref:`glossary`
         Common terms and their definitions.

doc/source/contributor/quickstart.rst

@@ -1,3 +1,5 @@
+.. _quickstart:
+
 ==========
 Quickstart
 ==========
@@ -60,7 +62,7 @@ can be customised by modifying the ``OPENSTACK_HOST`` and
     The DevStack project (http://devstack.org/) can be used to install
     an OpenStack development environment from scratch. For a local.conf that
     enables most services that Horizon supports managing, see
-    :doc:`local.conf <ref/local_conf>`
+    :ref:`local-conf`
 
 Horizon uses ``tox`` to manage virtual environments for testing and other
 development tasks. You can install it with

doc/source/contributor/ref/local_conf.rst

@@ -1,3 +1,5 @@
+.. _local-conf:
+
 ==========
 local.conf
 ==========

doc/source/contributor/ref/tables.rst

@@ -1,3 +1,5 @@
+.. _ref-datatables:
+
 ==================
 Horizon DataTables
 ==================
@@ -12,8 +14,8 @@ copy-and-paste every time you need a new table!
 
   .. seealso::
 
-    For usage information, tips & tricks and more examples check out the :doc:`DataTables Topic
+    For usage information, tips & tricks and more examples check out
-    Guide </topics/tables>`.
+    the :ref:`topics-datatables`.
 
 DataTable
 =========

doc/source/contributor/ref/workflows.rst

@@ -1,3 +1,5 @@
+.. _ref-workflows:
+
 =================
 Horizon Workflows
 =================
@@ -11,7 +13,7 @@ aims to bring that capability within everyday reach.
   .. seealso::
 
     For usage information, tips & tricks and more examples check out the
-    :doc:`Workflows Topic Guide </topics/workflows>`.
+    :ref:`topics-workflows`.
 
 Workflows
 =========

doc/source/contributor/testing.rst

@@ -152,5 +152,5 @@ should be written as unit tests. No doctests please.
 In general new code without unit tests will not be accepted, and every bugfix
 *must* include a regression test.
 
-For a much more in-depth discussion of testing, see the :doc:`testing topic
+For a much more in-depth discussion of testing, see the :ref:`testing topic
-guide </topics/testing>`.
+guide <topics-testing>`.

doc/source/contributor/topics/angularjs.rst

@@ -1,3 +1,5 @@
+.. _topics-angularjs:
+
 =====================
 AngularJS Topic Guide
 =====================
@@ -225,7 +227,7 @@ The code linting job can be run with ``tox -e npm -- lint``. If there are many
 warnings, you can also use ``tox -e npm -- lintq`` to see only errors and
 ignore warnings.
 
-For more detailed information, see :doc:`javascript_testing`.
+For more detailed information, see :ref:`topics-javascript-testing`.
 
 Translation (Internationalization and Localization)
 ===================================================
@@ -297,7 +299,7 @@ To manually add files, add the following arrays and file paths to the enabled fi
 Plugins
 -------
 
-Add a new panel/ panel group/ dashboard (See :doc:`/tutorials/dashboard`). JavaScript file
+Add a new panel/ panel group/ dashboard (See :ref:`tutorials-dashboard`). JavaScript file
 inclusion is the same as the Upstream process.
 
 To include external stylesheets, you must ensure that ``ADD_SCSS_FILES`` is

doc/source/contributor/topics/javascript_testing.rst

@@ -1,3 +1,5 @@
+.. _topics-javascript-testing:
+
 ==================
 JavaScript Testing
 ==================

doc/source/contributor/topics/policy.rst

@@ -1,3 +1,5 @@
+.. _topics-policy:
+
 ============================================================
 Horizon Policy Enforcement (RBAC: Role Based Access Control)
 ============================================================

doc/source/contributor/topics/styling.rst

@@ -5,7 +5,7 @@ Styling in Horizon (SCSS)
 Horizon uses `SCSS`_ (not to be confused with Sass) to style its HTML. This
 guide is targeted at developers adding code to upstream Horizon. For
 information on creating your own branding/theming, see
-:doc:`Customizing Horizon </install/customizing>`.
+:ref:`install-customizing`.
 
 .. _SCSS: http://sass-lang.com/guide
 

doc/source/contributor/topics/tables.rst

@@ -1,3 +1,5 @@
+.. _topics-datatables:
+
 ======================
 DataTables Topic Guide
 ======================
@@ -9,8 +11,7 @@ The core components of this API fall into three categories: ``DataTables``,
 
   .. seealso::
 
-    For a detailed API information check out the :doc:`DataTables Reference
+    For a detailed API information check out the :ref:`ref-datatables`.
-    Guide </ref/tables>`.
 
 Tables
 ======
@@ -155,8 +156,8 @@ will be made to determine if the action should be visible and will be
 displayed solely based on the result of
 :meth:`~horizon.tables.Action.allowed`.
 
-For more information on policy based Role Based Access Control see:
+For more information on policy based Role Based Access Control see
-:doc:`Horizon Policy Enforcement (RBAC: Role Based Access Control) </topics/policy>`.
+:ref:`topics-policy`.
 
 Table Cell filters (decorators)
 ===============================

doc/source/contributor/topics/testing.rst

@@ -1,3 +1,5 @@
+.. _topics-testing:
+
 ================
 Testing Overview
 ================

doc/source/contributor/topics/translation.rst

@@ -33,7 +33,7 @@ Message Extraction
 .. The source can be found at:
    https://drive.google.com/open?id=0B5nlaOV3OEj5MTNMdG9WV1RiVEU
 
-.. figure:: ../images/message_extraction.png
+.. figure:: ../../images/message_extraction.png
    :width: 80%
    :align: center
    :alt: Message extraction diagram
@@ -73,7 +73,7 @@ Message Substitution
 .. The source can be found at:
    https://drive.google.com/open?id=0B5nlaOV3OEj5UHZCNmFGT0lPQVU
 
-.. figure:: ../images/message_substitution.png
+.. figure:: ../../images/message_substitution.png
    :width: 80%
    :align: center
    :alt: Message substitution diagram

doc/source/contributor/topics/workflows.rst

@@ -1,3 +1,5 @@
+.. _topics-workflows:
+
 ======================
 Workflows Topic Guide
 ======================
@@ -8,8 +10,7 @@ aims to bring that capability within everyday reach.
 
   .. seealso::
 
-    For detailed API information refer to the :doc:`Workflows Reference
+    For detailed API information refer to the :ref:`ref-workflows`.
-    Guide </ref/workflows>`.
 
 Workflows
 =========

doc/source/contributor/tutorials/dashboard.rst

@@ -1,3 +1,5 @@
+.. _tutorials-dashboard:
+
 ============================================
 Tutorial: Building a Dashboard using Horizon
 ============================================
@@ -13,12 +15,11 @@ data pulled by the Nova instances API.
 
 .. note::
 
-    This tutorial assumes you have either a ``devstack`` or ``openstack``
+    This tutorial assumes you have either a ``devstack`` or
-    environment up and running.
+    ``openstack`` environment up and running.  There are a variety of
-    There are a variety of other resources which may be helpful to read first.
+    other resources which may be helpful to read first.  For example,
-    For example, you may want to start
+    you may want to start with the :ref:`quickstart` or the `Django
-    with the :doc:`Horizon quickstart guide </quickstart>` or the
+    tutorial`_.
-    `Django tutorial`_.
 
     .. _Django tutorial: https://docs.djangoproject.com/en/dev/intro/tutorial01/
 
@@ -581,8 +582,7 @@ Adding a complex action to a table
 ==================================
 
 For a more detailed look into adding a table action, one that requires forms for
-gathering data, you can walk through :doc:`Adding a complex action to a table
+gathering data, you can walk through :ref:`tutorials-table-actions` tutorial.
-</tutorials/table_actions>` tutorial.
 
 
 Conclusion

doc/source/contributor/tutorials/plugin.rst

@@ -1,6 +1,8 @@
-==============
+.. _tutorials-plugin:
-Horizon Plugin
+
-==============
+======================================
+ Tutorial: Creating an Horizon Plugin
+======================================
 
 Why should I package my code as a plugin?
 =========================================
@@ -48,10 +50,9 @@ If you are interested in creating a new panel, follow the steps below.
 
 ..  Note ::
 
-    This tutorial shows you how to create a new panel. If you are interested in
+    This tutorial shows you how to create a new panel. If you are
-    creating a new dashboard plugin, use the file structure from
+    interested in creating a new dashboard plugin, use the file
-    :doc:`Tutorial: Building a Dashboard using Horizon </tutorials/dashboard>`
+    structure from :ref:`tutorials-dashboard` instead.
-    instead.
 
 File Structure
 --------------
@@ -120,8 +121,7 @@ The Enabled File
 The enabled folder contains the configuration file(s) that registers your
 plugin with Horizon. The file is prefixed with an alpha-numeric string that
 determines the load order of your plugin. For more information on what you can
-include in this file, see pluggable settings in
+include in this file, see pluggable settings in :ref:`install-settings`.
-:doc:`Settings and Configuration </install/settings>`
 
 _31000_myplugin.py::
 

doc/source/contributor/tutorials/table_actions.rst

@@ -1,3 +1,5 @@
+.. _tutorials-table-actions:
+
 ============================================
 Tutorial: Adding a complex action to a table
 ============================================
@@ -5,9 +7,9 @@ Tutorial: Adding a complex action to a table
 This tutorial covers how to add a more complex action to a table, one that requires
 an action and form definitions, as well as changes to the view, urls, and table.
 
-This tutorial assumes you have already completed :doc:`Building a Dashboard using
+This tutorial assumes you have already completed
-Horizon  </tutorials/dashboard>`. If not, please do so now as we will be modifying the
+:ref:`tutorials-dashboard`. If not, please do so now as we will be
-files created there.
+modifying the files created there.
 
 This action will create a snapshot of the instance. When the action is taken,
 it will display a form that will allow the user to enter a snapshot name,

doc/source/contributor/tutorials/workflow_extend.rst

@@ -8,7 +8,7 @@ custom data handling logic. Refer to inline documentation on what those
 properties and methods are.
 
 We highly recommend that you complete the
-:doc:`plugin tutorial </tutorials/plugin>` if you have not done so already.
+:ref:`tutorials-plugin` if you have not done so already.
 If you do not know how to package and install a plugin, the rest of this
 tutorial will not make sense! In this tutorial, we will examine an existing
 workflow and how we can extend it as a plugin.
@@ -204,4 +204,4 @@ Testing
 
 Now that we have completed our plugin, lets package it and test that it works.
 If you need a refresher, take a look at the installation section in
-:doc:`Plugin Tutorial </tutorials/plugin>`.
+:ref:`tutorials-plugin`.

doc/source/glossary.rst

@@ -1,3 +1,5 @@
+.. _glossary:
+
 ========
 Glossary
 ========

doc/source/index.rst

@@ -26,9 +26,9 @@ Horizon is the canonical implementation of `OpenStack's Dashboard
 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>`.
+:ref:`contributor-intro`.
 
-To learn what you need to know to get going, see the :doc:`quickstart`.
+To learn what you need to know to get going, see the :ref:`quickstart`.
 
 Using Horizon
 =============
@@ -39,9 +39,10 @@ How to use Horizon in your own projects.
    :maxdepth: 2
 
    install/index
+   user/index
 
-Developer Docs
+Contributor Docs
-==============
+================
 
 For those wishing to develop Horizon itself, or go in-depth with building
 your own :class:`~horizon.Dashboard` or :class:`~horizon.Panel` classes,
@@ -50,14 +51,7 @@ the following documentation is provided.
 .. toctree::
    :maxdepth: 2
 
-   intro
+   contributor/index
-   quickstart
-   contributing
-   testing
-   browser_support
-   tutorials/index
-   topics/index
-   ref/index
 
 Release Notes
 =============
@@ -70,7 +64,6 @@ Information
 .. toctree::
    :maxdepth: 1
 
-   faq
    glossary
 
 * :ref:`genindex`

doc/source/install/customizing.rst

@@ -1,3 +1,5 @@
+.. _install-customizing:
+
 ===================
 Customizing Horizon
 ===================

doc/source/install/deploy-guide.rst

@@ -4,7 +4,7 @@ Installing and Deploying Horizon
 
 This page covers the basic installation of horizon in a production
 environment. If you are looking for a developer enviroment, see
-:doc:`Quickstart </quickstart>`.
+:ref:`quickstart`.
 
 .. _system-requirements-label:
 
@@ -27,7 +27,7 @@ System Requirements
   * `nova <https://docs.openstack.org/developer/nova>`_: Compute
   * `swift <https://docs.openstack.org/developer/swift>`_: Object Storage
   * Horizon also supports many other OpenStack services via plugins. For more
-    information, see the :doc:`plugin-registry`.
+    information, see the :ref:`install-plugin-registry`.
 
 Installation
 ============
@@ -54,7 +54,7 @@ Configuration
 =============
 
 This section contains a small summary of the critical settings required to run
-horizon. For more details, please refer to :doc:`settings`.
+horizon. For more details, please refer to :ref:`install-settings`.
 
 Settings
 --------
@@ -237,5 +237,5 @@ Deployment
 Next Steps
 ==========
 
-* :doc:`settings` lists the available settings for horizon.
+* :ref:`install-settings` lists the available settings for horizon.
-* :doc:`customizing` describes how to customize horizon.
+* :ref:`install-customizing` describes how to customize horizon.

doc/source/install/plugin-registry.rst

@@ -1,3 +1,5 @@
+.. _install-plugin-registry:
+
 ===============
 Plugin Registry
 ===============

doc/source/install/settings.rst

@@ -1,3 +1,5 @@
+.. _install-settings:
+
 ==========================
 Settings and Configuration
 ==========================

doc/source/user/index.rst

@@ -0,0 +1,8 @@
+====================
+ User Documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+
+   browser_support