openstack/horizon
Code Issues Proposed changes

Changing term 'name' to 'slug'

Browse Source 
The term name is used incorrectly and is misleading in the pluggable
extensions settings documentation and the enabled files. The value
that needs to be specified is the slug not the name. This correction
will aid in developers and deployers using the correct value.

Closes-Bug: #1408873
Change-Id: I96c5158bdaddeff7e9087cd9603344f2021a9570
This commit is contained in:
David Lyle 2015-01-08 17:27:06 -07:00
parent d9d8d861b1
commit 8e949857fd
11 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1023,7 +1023,7 @@ The following keys are specific to registering a dashboard:
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard to be added to ``HORIZON['dashboards']``. Required.
The slug of the dashboard to be added to ``HORIZON['dashboards']``. Required.
``DEFAULT``
-----------
@ -1071,14 +1071,14 @@ The following keys are specific to registering or removing a panel:
.. versionadded:: 2014.1(Icehouse)
The name of the panel to be added to ``HORIZON_CONFIG``. Required.
The slug of the panel to be added to ``HORIZON_CONFIG``. Required.
``PANEL_DASHBOARD``
-------------------
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard the ``PANEL`` associated with. Required.
The slug of the dashboard the ``PANEL`` associated with. Required.
``PANEL_GROUP``
@ -1086,8 +1086,8 @@ The name of the dashboard the ``PANEL`` associated with. Required.
.. versionadded:: 2014.1(Icehouse)
The name of the panel group the ``PANEL`` is associated with. If you want the panel to show up
without a panel group, use the panel group "default".
The slug of the panel group the ``PANEL`` is associated with. If you want the
panel to show up without a panel group, use the panel group "default".
``DEFAULT_PANEL``
-----------------
@ -1154,7 +1154,7 @@ The following keys are specific to registering a panel group:
.. versionadded:: 2014.1(Icehouse)
The name of the panel group to be added to ``HORIZON_CONFIG``. Required.
The slug of the panel group to be added to ``HORIZON_CONFIG``. Required.
``PANEL_GROUP_NAME``
--------------------
@ -1168,7 +1168,7 @@ The display name of the PANEL_GROUP. Required.
.. versionadded:: 2014.1(Icehouse)
The name of the dashboard the ``PANEL_GROUP`` associated with. Required.
The slug of the dashboard the ``PANEL_GROUP`` associated with. Required.

2
openstack_dashboard/enabled/_10_project.py
View File

@ -1,4 +1,4 @@
# The name of the dashboard to be added to HORIZON['dashboards']. Required.
# The slug of the dashboard to be added to HORIZON['dashboards']. Required.
DASHBOARD = 'project'
# If set to True, this dashboard will be set as the default dashboard.
DEFAULT = True

2
openstack_dashboard/enabled/_20_admin.py
View File

@ -1,4 +1,4 @@
# The name of the dashboard to be added to HORIZON['dashboards']. Required.
# The slug of the dashboard to be added to HORIZON['dashboards']. Required.
DASHBOARD = 'admin'
# A list of applications to be added to INSTALLED_APPS.

2
openstack_dashboard/enabled/_25_identity.py
View File

@ -1,4 +1,4 @@
# The name of the dashboard to be added to HORIZON['dashboards']. Required.
# The slug of the dashboard to be added to HORIZON['dashboards']. Required.
DASHBOARD = 'identity'
# If set to True, this dashboard will be set as the default dashboard.
DEFAULT = False

2
openstack_dashboard/enabled/_30_settings.py
View File

@ -1,4 +1,4 @@
# The name of the dashboard to be added to HORIZON['dashboards']. Required.
# The slug of the dashboard to be added to HORIZON['dashboards']. Required.
DASHBOARD = 'settings'
# A list of applications to be added to INSTALLED_APPS.

2
openstack_dashboard/enabled/_40_router.py
View File

@ -1,4 +1,4 @@
# The name of the dashboard to be added to HORIZON['dashboards']. Required.
# The slug of the dashboard to be added to HORIZON['dashboards']. Required.
DASHBOARD = 'router'
# A list of applications to be added to INSTALLED_APPS.

6
openstack_dashboard/enabled/_50_admin_add_panel.py.example
View File

@ -1,8 +1,8 @@
# The name of the panel to be added to HORIZON_CONFIG. Required.
# The slug of the panel to be added to HORIZON_CONFIG. Required.
PANEL = 'plugin_panel'
# The name of the dashboard the PANEL associated with. Required.
# The slug of the dashboard the PANEL associated with. Required.
PANEL_DASHBOARD = 'admin'
# The name of the panel group the PANEL is associated with.
# The slug of the panel group the PANEL is associated with.
PANEL_GROUP = 'admin'
# Python panel class of the PANEL to be added.

6
openstack_dashboard/enabled/_60_admin_remove_panel.py.example
View File

@ -1,8 +1,8 @@
# The name of the panel to be added to HORIZON_CONFIG. Required.
# The slug of the panel to be added to HORIZON_CONFIG. Required.
PANEL = 'info'
# The name of the dashboard the PANEL associated with. Required.
# The slug of the dashboard the PANEL associated with. Required.
PANEL_DASHBOARD = 'admin'
# The name of the panel group the PANEL is associated with.
# The slug of the panel group the PANEL is associated with.
PANEL_GROUP = 'admin'
# If set to True, the panel will be removed from PANEL_DASHBOARD/PANEL_GROUP.

6
openstack_dashboard/enabled/_70_admin_default_panel.py.example
View File

@ -1,8 +1,8 @@
# The name of the panel to be added to HORIZON_CONFIG. Required.
# The slug of the panel to be added to HORIZON_CONFIG. Required.
PANEL = 'defaults'
# The name of the dashboard the PANEL associated with. Required.
# The slug of the dashboard the PANEL associated with. Required.
PANEL_DASHBOARD = 'admin'
# The name of the panel group the PANEL is associated with.
# The slug of the panel group the PANEL is associated with.
PANEL_GROUP = 'admin'
# If set, it will update the default panel of the PANEL_DASHBOARD.

4
openstack_dashboard/enabled/_80_admin_add_panel_group.py.example
View File

@ -1,6 +1,6 @@
# The name of the panel group to be added to HORIZON_CONFIG. Required.
# The slug of the panel group to be added to HORIZON_CONFIG. Required.
PANEL_GROUP = 'plugin_panel_group'
# The display name of the PANEL_GROUP. Required.
PANEL_GROUP_NAME = 'Plugin Panel Group'
# The name of the dashboard the PANEL_GROUP associated with. Required.
# The slug of the dashboard the PANEL_GROUP associated with. Required.
PANEL_GROUP_DASHBOARD = 'admin'

6
openstack_dashboard/enabled/_90_admin_add_panel_to_group.py.example
View File

@ -1,8 +1,8 @@
# The name of the panel to be added to HORIZON_CONFIG. Required.
# The slug of the panel to be added to HORIZON_CONFIG. Required.
PANEL = 'plugin_panel'
# The name of the dashboard the PANEL associated with. Required.
# The slug of the dashboard the PANEL associated with. Required.
PANEL_DASHBOARD = 'admin'
# The name of the panel group the PANEL is associated with.
# The slug of the panel group the PANEL is associated with.
PANEL_GROUP = 'plugin_panel_group'
# Python panel class of the PANEL to be added.