diff --git a/doc/source/topics/settings.rst b/doc/source/topics/settings.rst index 72ba6c0312..63be65240c 100755 --- a/doc/source/topics/settings.rst +++ b/doc/source/topics/settings.rst @@ -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. diff --git a/openstack_dashboard/enabled/_10_project.py b/openstack_dashboard/enabled/_10_project.py index ae34a869d4..d695df19cd 100644 --- a/openstack_dashboard/enabled/_10_project.py +++ b/openstack_dashboard/enabled/_10_project.py @@ -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 diff --git a/openstack_dashboard/enabled/_20_admin.py b/openstack_dashboard/enabled/_20_admin.py index ed7b93c97b..b36079e0ee 100644 --- a/openstack_dashboard/enabled/_20_admin.py +++ b/openstack_dashboard/enabled/_20_admin.py @@ -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. diff --git a/openstack_dashboard/enabled/_25_identity.py b/openstack_dashboard/enabled/_25_identity.py index c61a833ecb..4f46736ada 100644 --- a/openstack_dashboard/enabled/_25_identity.py +++ b/openstack_dashboard/enabled/_25_identity.py @@ -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 diff --git a/openstack_dashboard/enabled/_30_settings.py b/openstack_dashboard/enabled/_30_settings.py index 984b268a73..23d714c4ab 100644 --- a/openstack_dashboard/enabled/_30_settings.py +++ b/openstack_dashboard/enabled/_30_settings.py @@ -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. diff --git a/openstack_dashboard/enabled/_40_router.py b/openstack_dashboard/enabled/_40_router.py index d81e326ef6..e1124fc8a0 100644 --- a/openstack_dashboard/enabled/_40_router.py +++ b/openstack_dashboard/enabled/_40_router.py @@ -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. diff --git a/openstack_dashboard/enabled/_50_admin_add_panel.py.example b/openstack_dashboard/enabled/_50_admin_add_panel.py.example index 537aac75f4..b3c2acd4b2 100644 --- a/openstack_dashboard/enabled/_50_admin_add_panel.py.example +++ b/openstack_dashboard/enabled/_50_admin_add_panel.py.example @@ -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. diff --git a/openstack_dashboard/enabled/_60_admin_remove_panel.py.example b/openstack_dashboard/enabled/_60_admin_remove_panel.py.example index 94d2856f83..1468ee8445 100644 --- a/openstack_dashboard/enabled/_60_admin_remove_panel.py.example +++ b/openstack_dashboard/enabled/_60_admin_remove_panel.py.example @@ -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. diff --git a/openstack_dashboard/enabled/_70_admin_default_panel.py.example b/openstack_dashboard/enabled/_70_admin_default_panel.py.example index b38ebdaf89..9f77d3a21d 100644 --- a/openstack_dashboard/enabled/_70_admin_default_panel.py.example +++ b/openstack_dashboard/enabled/_70_admin_default_panel.py.example @@ -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. diff --git a/openstack_dashboard/enabled/_80_admin_add_panel_group.py.example b/openstack_dashboard/enabled/_80_admin_add_panel_group.py.example index b0fd2d1b75..21106ad369 100644 --- a/openstack_dashboard/enabled/_80_admin_add_panel_group.py.example +++ b/openstack_dashboard/enabled/_80_admin_add_panel_group.py.example @@ -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' diff --git a/openstack_dashboard/enabled/_90_admin_add_panel_to_group.py.example b/openstack_dashboard/enabled/_90_admin_add_panel_to_group.py.example index e9394611c2..f6d5cdfa07 100644 --- a/openstack_dashboard/enabled/_90_admin_add_panel_to_group.py.example +++ b/openstack_dashboard/enabled/_90_admin_add_panel_to_group.py.example @@ -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.