The explanation of how to use the customization_module may confuse users.

Bug #1626858 reported by Kenji Ishii
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Low
Kenji Ishii

Bug Description

The explanation of how to use costomization_module is writtend by http://docs.openstack.org/developer/horizon/topics/customizing.html#horizon-customization-module-overrides.

And this sample code is below.

HORIZON_CONFIG = {
    "customization_module": "my_project.overrides"
}

However, if a user do so, other attributes that HORIZON_CONFIG have are eliminated.
In latest horizon, it would caues circular redirect loop.
So, Avoiding confusing users, we should indicate more safe way like below.

HORIZON_CONFIG["customization_module"] = "my_project.overrides"

Kenji Ishii (ken-ishii)
Changed in horizon:
assignee: nobody → Kenji Ishii (ken-ishii)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to horizon (master)

Fix proposed to branch: master
Review: https://review.openstack.org/375275

Changed in horizon:
status: New → In Progress
Changed in horizon:
milestone: none → ocata-1
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to horizon (master)

Reviewed: https://review.openstack.org/375275
Committed: https://git.openstack.org/cgit/openstack/horizon/commit/?id=07185eca288095bbf8f0508e68f2ddff43dfb534
Submitter: Jenkins
Branch: master

commit 07185eca288095bbf8f0508e68f2ddff43dfb534
Author: Kenji Ishii <email address hidden>
Date: Fri Sep 23 15:52:07 2016 +0900

    Fix the exapmle of how to use customization_module

    If a user use current example[1] as is, other attributes that
    HORIZON_CONFIG have are eliminated. As a result, some unexpected
    behavior may occur. So, this patch modify the exapmle.

    [1]:http://docs.openstack.org/developer/horizon/topics/customizing.html

    Change-Id: I022a73e6da6ad9b8ae1f807838cf29efedf7e1ef
    Closes-Bug: #1626858

Changed in horizon:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/horizon 11.0.0.0b1

This issue was fixed in the openstack/horizon 11.0.0.0b1 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.