diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 99% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index 9d8a5302d1..d271709522 100644 --- a/doc/source/contributing.rst +++ b/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" ~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/faq.rst b/doc/source/contributor/faq.rst similarity index 99% rename from doc/source/faq.rst rename to doc/source/contributor/faq.rst index 2a511c1db9..c1c7ab3154 100644 --- a/doc/source/faq.rst +++ b/doc/source/contributor/faq.rst @@ -1,3 +1,5 @@ +.. _faq: + ========================== Frequently Asked Questions ========================== diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000000..3c7051e103 --- /dev/null +++ b/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 diff --git a/doc/source/intro.rst b/doc/source/contributor/intro.rst similarity index 97% rename from doc/source/intro.rst rename to doc/source/contributor/intro.rst index 2b5481c8dd..d8dc1b8bc0 100644 --- a/doc/source/intro.rst +++ b/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 ` + :ref:`quickstart` A short guide to getting started with using Horizon. - :doc:`Frequently Asked Questions ` + :ref:`faq` Common questions and answers. - :doc:`Glossary ` + :ref:`glossary` Common terms and their definitions. diff --git a/doc/source/quickstart.rst b/doc/source/contributor/quickstart.rst similarity index 99% rename from doc/source/quickstart.rst rename to doc/source/contributor/quickstart.rst index a8a2f62073..7a87cd91f9 100644 --- a/doc/source/quickstart.rst +++ b/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` Horizon uses ``tox`` to manage virtual environments for testing and other development tasks. You can install it with diff --git a/doc/source/ref/context_processors.rst b/doc/source/contributor/ref/context_processors.rst similarity index 100% rename from doc/source/ref/context_processors.rst rename to doc/source/contributor/ref/context_processors.rst diff --git a/doc/source/ref/decorators.rst b/doc/source/contributor/ref/decorators.rst similarity index 100% rename from doc/source/ref/decorators.rst rename to doc/source/contributor/ref/decorators.rst diff --git a/doc/source/ref/exceptions.rst b/doc/source/contributor/ref/exceptions.rst similarity index 100% rename from doc/source/ref/exceptions.rst rename to doc/source/contributor/ref/exceptions.rst diff --git a/doc/source/ref/forms.rst b/doc/source/contributor/ref/forms.rst similarity index 100% rename from doc/source/ref/forms.rst rename to doc/source/contributor/ref/forms.rst diff --git a/doc/source/ref/horizon.rst b/doc/source/contributor/ref/horizon.rst similarity index 100% rename from doc/source/ref/horizon.rst rename to doc/source/contributor/ref/horizon.rst diff --git a/doc/source/ref/index.rst b/doc/source/contributor/ref/index.rst similarity index 100% rename from doc/source/ref/index.rst rename to doc/source/contributor/ref/index.rst diff --git a/doc/source/ref/local_conf.rst b/doc/source/contributor/ref/local_conf.rst similarity index 99% rename from doc/source/ref/local_conf.rst rename to doc/source/contributor/ref/local_conf.rst index 1d1ecff524..af47dff587 100644 --- a/doc/source/ref/local_conf.rst +++ b/doc/source/contributor/ref/local_conf.rst @@ -1,3 +1,5 @@ +.. _local-conf: + ========== local.conf ========== diff --git a/doc/source/ref/middleware.rst b/doc/source/contributor/ref/middleware.rst similarity index 100% rename from doc/source/ref/middleware.rst rename to doc/source/contributor/ref/middleware.rst diff --git a/doc/source/ref/run_tests.rst b/doc/source/contributor/ref/run_tests.rst similarity index 100% rename from doc/source/ref/run_tests.rst rename to doc/source/contributor/ref/run_tests.rst diff --git a/doc/source/ref/tables.rst b/doc/source/contributor/ref/tables.rst similarity index 97% rename from doc/source/ref/tables.rst rename to doc/source/contributor/ref/tables.rst index e15d06b4df..9f9f6fab85 100644 --- a/doc/source/ref/tables.rst +++ b/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 - Guide `. + For usage information, tips & tricks and more examples check out + the :ref:`topics-datatables`. DataTable ========= diff --git a/doc/source/ref/tabs.rst b/doc/source/contributor/ref/tabs.rst similarity index 100% rename from doc/source/ref/tabs.rst rename to doc/source/contributor/ref/tabs.rst diff --git a/doc/source/ref/test.rst b/doc/source/contributor/ref/test.rst similarity index 100% rename from doc/source/ref/test.rst rename to doc/source/contributor/ref/test.rst diff --git a/doc/source/ref/workflows.rst b/doc/source/contributor/ref/workflows.rst similarity index 91% rename from doc/source/ref/workflows.rst rename to doc/source/contributor/ref/workflows.rst index 23e78decf7..3bff1c7f7d 100644 --- a/doc/source/ref/workflows.rst +++ b/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 `. + :ref:`topics-workflows`. Workflows ========= diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst similarity index 98% rename from doc/source/testing.rst rename to doc/source/contributor/testing.rst index f57909a48a..0ec784ff44 100644 --- a/doc/source/testing.rst +++ b/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 -guide `. +For a much more in-depth discussion of testing, see the :ref:`testing topic +guide `. diff --git a/doc/source/topics/angularjs.rst b/doc/source/contributor/topics/angularjs.rst similarity index 98% rename from doc/source/topics/angularjs.rst rename to doc/source/contributor/topics/angularjs.rst index e8947b5b5d..f7cc95861d 100644 --- a/doc/source/topics/angularjs.rst +++ b/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 diff --git a/doc/source/topics/index.rst b/doc/source/contributor/topics/index.rst similarity index 100% rename from doc/source/topics/index.rst rename to doc/source/contributor/topics/index.rst diff --git a/doc/source/topics/javascript_testing.rst b/doc/source/contributor/topics/javascript_testing.rst similarity index 99% rename from doc/source/topics/javascript_testing.rst rename to doc/source/contributor/topics/javascript_testing.rst index 71b8a35767..50eda868cc 100644 --- a/doc/source/topics/javascript_testing.rst +++ b/doc/source/contributor/topics/javascript_testing.rst @@ -1,3 +1,5 @@ +.. _topics-javascript-testing: + ================== JavaScript Testing ================== diff --git a/doc/source/topics/microversion_support.rst b/doc/source/contributor/topics/microversion_support.rst similarity index 100% rename from doc/source/topics/microversion_support.rst rename to doc/source/contributor/topics/microversion_support.rst diff --git a/doc/source/topics/packaging.rst b/doc/source/contributor/topics/packaging.rst similarity index 100% rename from doc/source/topics/packaging.rst rename to doc/source/contributor/topics/packaging.rst diff --git a/doc/source/topics/policy.rst b/doc/source/contributor/topics/policy.rst similarity index 99% rename from doc/source/topics/policy.rst rename to doc/source/contributor/topics/policy.rst index f236ced03e..b7653a1652 100644 --- a/doc/source/topics/policy.rst +++ b/doc/source/contributor/topics/policy.rst @@ -1,3 +1,5 @@ +.. _topics-policy: + ============================================================ Horizon Policy Enforcement (RBAC: Role Based Access Control) ============================================================ diff --git a/doc/source/topics/styling.rst b/doc/source/contributor/topics/styling.rst similarity index 98% rename from doc/source/topics/styling.rst rename to doc/source/contributor/topics/styling.rst index 3ce552d307..59337d18bb 100644 --- a/doc/source/topics/styling.rst +++ b/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 `. +:ref:`install-customizing`. .. _SCSS: http://sass-lang.com/guide diff --git a/doc/source/topics/tables.rst b/doc/source/contributor/topics/tables.rst similarity index 98% rename from doc/source/topics/tables.rst rename to doc/source/contributor/topics/tables.rst index 37214805b1..9dbfe6a30e 100644 --- a/doc/source/topics/tables.rst +++ b/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 - Guide `. + For a detailed API information check out the :ref:`ref-datatables`. 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: -:doc:`Horizon Policy Enforcement (RBAC: Role Based Access Control) `. +For more information on policy based Role Based Access Control see +:ref:`topics-policy`. Table Cell filters (decorators) =============================== diff --git a/doc/source/topics/testing.rst b/doc/source/contributor/topics/testing.rst similarity index 99% rename from doc/source/topics/testing.rst rename to doc/source/contributor/topics/testing.rst index 46e96beade..55074eb6ba 100644 --- a/doc/source/topics/testing.rst +++ b/doc/source/contributor/topics/testing.rst @@ -1,3 +1,5 @@ +.. _topics-testing: + ================ Testing Overview ================ diff --git a/doc/source/topics/translation.rst b/doc/source/contributor/topics/translation.rst similarity index 99% rename from doc/source/topics/translation.rst rename to doc/source/contributor/topics/translation.rst index a3207d0946..c59eb46999 100644 --- a/doc/source/topics/translation.rst +++ b/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 diff --git a/doc/source/topics/workflows.rst b/doc/source/contributor/topics/workflows.rst similarity index 98% rename from doc/source/topics/workflows.rst rename to doc/source/contributor/topics/workflows.rst index fe6bf661ed..1dd4b2c4d8 100644 --- a/doc/source/topics/workflows.rst +++ b/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 - Guide `. + For detailed API information refer to the :ref:`ref-workflows`. Workflows ========= diff --git a/doc/source/tutorials/dashboard.rst b/doc/source/contributor/tutorials/dashboard.rst similarity index 97% rename from doc/source/tutorials/dashboard.rst rename to doc/source/contributor/tutorials/dashboard.rst index 412f85de76..ca0c524ce1 100644 --- a/doc/source/tutorials/dashboard.rst +++ b/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`` - environment up and running. - There are a variety of other resources which may be helpful to read first. - For example, you may want to start - with the :doc:`Horizon quickstart guide ` or the - `Django tutorial`_. + This tutorial assumes you have either a ``devstack`` or + ``openstack`` environment up and running. There are a variety of + other resources which may be helpful to read first. For example, + you may want to start with the :ref:`quickstart` or the `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 -` tutorial. +gathering data, you can walk through :ref:`tutorials-table-actions` tutorial. Conclusion diff --git a/doc/source/tutorials/index.rst b/doc/source/contributor/tutorials/index.rst similarity index 100% rename from doc/source/tutorials/index.rst rename to doc/source/contributor/tutorials/index.rst diff --git a/doc/source/tutorials/plugin.rst b/doc/source/contributor/tutorials/plugin.rst similarity index 98% rename from doc/source/tutorials/plugin.rst rename to doc/source/contributor/tutorials/plugin.rst index b5c5f4c13d..d610a7c68d 100644 --- a/doc/source/tutorials/plugin.rst +++ b/doc/source/contributor/tutorials/plugin.rst @@ -1,6 +1,8 @@ -============== -Horizon Plugin -============== +.. _tutorials-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 - creating a new dashboard plugin, use the file structure from - :doc:`Tutorial: Building a Dashboard using Horizon ` - instead. + This tutorial shows you how to create a new panel. If you are + interested in creating a new dashboard plugin, use the file + structure from :ref:`tutorials-dashboard` 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 -:doc:`Settings and Configuration ` +include in this file, see pluggable settings in :ref:`install-settings`. _31000_myplugin.py:: diff --git a/doc/source/tutorials/table_actions.rst b/doc/source/contributor/tutorials/table_actions.rst similarity index 98% rename from doc/source/tutorials/table_actions.rst rename to doc/source/contributor/tutorials/table_actions.rst index b02d74bd57..d0308c684e 100644 --- a/doc/source/tutorials/table_actions.rst +++ b/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 -Horizon `. If not, please do so now as we will be modifying the -files created there. +This tutorial assumes you have already completed +:ref:`tutorials-dashboard`. If not, please do so now as we will be +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, diff --git a/doc/source/tutorials/workflow_extend.rst b/doc/source/contributor/tutorials/workflow_extend.rst similarity index 98% rename from doc/source/tutorials/workflow_extend.rst rename to doc/source/contributor/tutorials/workflow_extend.rst index 7a842936b3..c81136e859 100644 --- a/doc/source/tutorials/workflow_extend.rst +++ b/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 ` 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 `. +:ref:`tutorials-plugin`. diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index 7cabc2f430..a86b22ded3 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -1,3 +1,5 @@ +.. _glossary: + ======== Glossary ======== diff --git a/doc/source/index.rst b/doc/source/index.rst index faa9d7c00d..43a3de5935 100644 --- a/doc/source/index.rst +++ b/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 `. +: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 - quickstart - contributing - testing - browser_support - tutorials/index - topics/index - ref/index + contributor/index Release Notes ============= @@ -70,7 +64,6 @@ Information .. toctree:: :maxdepth: 1 - faq glossary * :ref:`genindex` diff --git a/doc/source/install/customizing.rst b/doc/source/install/customizing.rst index 9e380df717..1c1fef07a4 100644 --- a/doc/source/install/customizing.rst +++ b/doc/source/install/customizing.rst @@ -1,3 +1,5 @@ +.. _install-customizing: + =================== Customizing Horizon =================== diff --git a/doc/source/install/deploy-guide.rst b/doc/source/install/deploy-guide.rst index 87e66b35fe..663cd615b9 100644 --- a/doc/source/install/deploy-guide.rst +++ b/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 `. +:ref:`quickstart`. .. _system-requirements-label: @@ -27,7 +27,7 @@ System Requirements * `nova `_: Compute * `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. -* :doc:`customizing` describes how to customize horizon. +* :ref:`install-settings` lists the available settings for horizon. +* :ref:`install-customizing` describes how to customize horizon. diff --git a/doc/source/install/plugin-registry.rst b/doc/source/install/plugin-registry.rst index 9a04973b83..3745fc369a 100644 --- a/doc/source/install/plugin-registry.rst +++ b/doc/source/install/plugin-registry.rst @@ -1,3 +1,5 @@ +.. _install-plugin-registry: + =============== Plugin Registry =============== diff --git a/doc/source/install/settings.rst b/doc/source/install/settings.rst index 3b876dd336..eaf3abb869 100644 --- a/doc/source/install/settings.rst +++ b/doc/source/install/settings.rst @@ -1,3 +1,5 @@ +.. _install-settings: + ========================== Settings and Configuration ========================== diff --git a/doc/source/browser_support.rst b/doc/source/user/browser_support.rst similarity index 100% rename from doc/source/browser_support.rst rename to doc/source/user/browser_support.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000000..1f3e49c3a5 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,8 @@ +==================== + User Documentation +==================== + +.. toctree:: + :maxdepth: 2 + + browser_support