Merge "Fix documentation about adding a new dashboard"

This commit is contained in:
Jenkins 2014-04-03 19:25:50 +00:00 committed by Gerrit Code Review
commit 37a2a12d2a
2 changed files with 13 additions and 15 deletions

View File

@ -102,21 +102,17 @@ they should be added to ``requirements.txt``.
Project
=======
INSTALLED_APPS
--------------
Dashboard configuration
-----------------------
At the project level you add Horizon and any desired dashboards to your
``settings.INSTALLED_APPS``::
To add a new dashboard to your project, you need to add a configuration file to
``openstack_dashboard/local/enabled`` directory. For more information on this,
see :ref:`pluggable-settings-label`.
INSTALLED_APPS = (
'openstack_dashboard',
...
'horizon',
'openstack_dashboard.dashboards.project',
'openstack_dashboard.dashboards.admin',
'openstack_dashboard.dashboards.settings',
...
)
There is also an alternative way to add a new dashboard, by adding it to
Django's ``INSTALLED_APPS`` setting. For more information about this, see
:ref:`dashboards`. However, please note that the recommended way is to take
advantage of the pluggable settings feature.
URLs
----
@ -157,14 +153,14 @@ Application
Structure
---------
An application would have the following structure (we'll use syspanel as
An application would have the following structure (we'll use project as
an example)::
project/
|---__init__.py
|---dashboard.py <-----Registers the app with Horizon and sets dashboard properties
|---overview/
|---images_and_snapshots/
|---images/
|-- images
|-- __init__.py
|---panel.py <-----Registers the panel in the app and defines panel properties

View File

@ -37,6 +37,8 @@ The following options are available in order to configure/customize the
behavior of your Horizon installation. All of them are contained in the
``HORIZON_CONFIG`` dictionary.
.. _dashboards:
``dashboards``
--------------