From 2c464340a4a36a57cf7824dd0d35ef13bfaca483 Mon Sep 17 00:00:00 2001 From: Ana Krivokapic Date: Sat, 29 Mar 2014 18:30:46 +0100 Subject: [PATCH] Fix documentation about adding a new dashboard Since blueprint plugin-architecture has been implemented, the preferred way to add a new dashboard is a configuration file, rather than an entry in INSTALLED_APPS. This patch changes the developer documentation to reflect this change. Change-Id: I569b22b81da1442ec9bed13d50ebfccfff093ac7 --- doc/source/quickstart.rst | 26 +++++++++++--------------- doc/source/topics/settings.rst | 2 ++ 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst index 3c3240da3b..da59f81ef8 100644 --- a/doc/source/quickstart.rst +++ b/doc/source/quickstart.rst @@ -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 diff --git a/doc/source/topics/settings.rst b/doc/source/topics/settings.rst index 43e5eb2444..8192344219 100644 --- a/doc/source/topics/settings.rst +++ b/doc/source/topics/settings.rst @@ -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`` --------------