openstack/horizon
Code Issues Proposed changes

Update settings docs with using ANGULAR_FEATURES for dev

Browse Source 
Note in settings documentation (for upstream developers)
that from Newton forward, we should use the ANGULAR_FEATURES
setting instead of creating an enabled file like
_3031_identity_ng_users_panel.py...
and DISABLE-ing it there.

This makes sure we only display one service panel at a time
(either Django or Angular) and not both.

Change-Id: I120011ada793eeee92fd0871e6771d755a34d7f0
This commit is contained in:
Cindy Lu 2016-11-30 12:12:31 -08:00
parent 2394397bfd
commit 6585659162
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/topics/settings.rst
View File

@ -67,6 +67,10 @@ Horizon Dashboards are automatically discovered in the following way:
`INSTALLED_APPS <https://docs.djangoproject.com/en/dev/ref/settings/#std:setting-INSTALLED_APPS>`_
and importing any files that have the name ``"dashboard.py"`` and include
code to register themselves as a Horizon dashboard.
* For upstream development since Newton, please use ``ANGULAR_FEATURES`` setting to
toggle Angular panel features, instead of defining an enabled file for the
Angular panel. Then use ``settings.ANGULAR_FEATURES[<panel_name>]`` in your urls.py.
This enforces showing one service panel in the dashboard at a time.
By default, dashboards defined by ``openstack_dashboard/local/enabled`` are
displayed first in the alphabetical order of the config files, and then the