Help link in Horizon redirects the user to the latest OpenStack release docs

Bug #1940318 reported by Heitor Matsui
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Fix Released
Low
Heitor Matsui

Bug Description

Brief Description
-----------------
In Horizon, the 'Help' button in the user's dropdown menu, located at the top right corner, redirects the user to https://docs.openstack.org/, which will open the latest OpenStack release docs (which is currently Wallaby), instead of opening the proper Ussuri documentation

Severity
--------
Minor

Steps to Reproduce
------------------
Log into Horizon, click your user's dropdown menu at the top right corner and then click the Help button

Expected Behavior
------------------
The user is taken to the applied OpenStack release documentation

Actual Behavior
----------------
The user is taken to the latest upstream release documentation

Reproducibility
---------------
Reproducible

System Configuration
--------------------
Any

Branch/Pull Time/Commit
-----------------------
master

Last Pass
---------
N/A

Timestamp/Logs
--------------
Snippet of the HTML from the user's dropdown menu at the top right corner, the second <a> tag is the one that points to the Help URL:

<ul id="editor_list" class="dropdown-menu dropdown-menu-right selection-menu">
    <li><a href="/settings/" target="_self"><span class="fa fa-cog"></span>
            Settings
        </a></li>
    <li><a href="http://docs.openstack.org" target="_blank"><span class="fa fa-question-circle"></span>
            Help
        </a></li>
    <li><a href="/project/api_access/openrc/"><span class="fa fa-download"></span>

            OpenStack RC File
        </a></li>
    <li class="divider"></li>
    <li>
        <ul class="dropdown-menu theme-picker">
            <li class="dropdown-header">Themes:</li>
            <li><a data-theme="default" class="theme-default theme-picker-item dropdown-selected disabled" href="#"
                    target="_self"><span class="fa fa-check dropdown-selected-icon"></span><span
                        class="dropdown-title">Default</span></a></li>
            <li><a data-theme="material" class="theme-material theme-picker-item openstack-spin" href="#"
                    target="_self"><span class="fa fa-check dropdown-selected-icon"></span><span
                        class="dropdown-title">Material</span></a></li>
        </ul>
        <script>
            $(document).ready(function () {

                horizon.addInitFunction(function () {

                    $(document).on('click', '.theme-picker-item', function (e) {
                        var $this = $(this);

                        // prevent the default <a> click handler from firing - on
                        // Chrome it confuses the reload() we do below
                        e.preventDefault();

                        if ($this.hasClass('disabled')) {
                            e.stopPropagation();
                            return;
                        }

                        var CookieDate = new Date;
                        CookieDate.setFullYear(CookieDate.getFullYear() + 10);

                        document.cookie = 'theme=' + $this.data('theme') + '; path=/; expires=' + CookieDate.toGMTString() + ';';
                        document.location.reload();
                    });
                });
            });
        </script>
    </li>
    <li class="divider"></li>
    <li><a href="/auth/logout/" target="_self"><span class="fa fa-sign-out"></span>
            Sign Out
        </a></li>
</ul>

Test Activity
-------------
Regression Testing

Workaround
----------
Open the correct documentation

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-armada-app (master)
Changed in starlingx:
status: New → In Progress
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-armada-app (master)

Reviewed: https://review.opendev.org/c/starlingx/openstack-armada-app/+/804912
Committed: https://opendev.org/starlingx/openstack-armada-app/commit/f445dbe8e24b447aaf995b5d563e1c6ee483c8cd
Submitter: "Zuul (22348)"
Branch: master

commit f445dbe8e24b447aaf995b5d563e1c6ee483c8cd
Author: Heitor Matsui <email address hidden>
Date: Tue Aug 17 15:32:21 2021 -0300

    Change default Help URL on Horizon

    The Help URL at user's dropdown located on the top right corner is
    taking the user, by default, to the latest release documentation,
    which changes over time and is not the current release used by
    stx-openstack. Also this change allows the URL to be easily replaced
    as desired via helm-overrides.

    Closes-Bug: #1940318
    Signed-off-by: Heitor Matsui <email address hidden>
    Change-Id: I74b7218356518ac1407091b010949ed90abd169d

Changed in starlingx:
status: In Progress → Fix Released
Ghada Khalil (gkhalil)
Changed in starlingx:
importance: Undecided → Low
tags: added: stx.6.0 stx.distro.openstack stx.gui
Changed in starlingx:
assignee: nobody → Heitor Matsui (heitormatsui)
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.