Bug 1336526 - Link to Documentation from the Help dropdowns is hard coded
Summary: Link to Documentation from the Help dropdowns is hard coded
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Management Console
Version: 3.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: ---
: 3.2.1
Assignee: Robb Hamilton
QA Contact: Yadan Pei
URL:
Whiteboard:
: 1342144 1342580 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-05-16 17:49 UTC by Robb Hamilton
Modified: 2019-11-14 08:03 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
The Documentation link in the "?" drop-down menu was hard-coded instead of using the method described in https://docs.openshift.com/enterprise/latest/install_config/web_console_customization.html#changing-links-to-documentation. This bug fix updates the web console, and now this link can be customized as expected.
Clone Of:
Environment:
Last Closed: 2016-06-27 15:07:15 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHBA-2016:1343 0 normal SHIPPED_LIVE Red Hat OpenShift Enterprise 3.2.1.1 bug fix and enhancement update 2016-06-27 19:04:05 UTC

Description Robb Hamilton 2016-05-16 17:49:40 UTC 
Description of problem:  The link to Documentation from the Help dropdowns is hard coded instead of using the helpLink filter and corresponding constants.
Comment 1 Robb Hamilton 2016-05-16 17:50:30 UTC 
PR to fix:  https://github.com/openshift/ose/pull/228
Comment 2 Jessica Forrester 2016-06-02 18:24:14 UTC 
*** Bug 1342144 has been marked as a duplicate of this bug. ***
Comment 3 Jessica Forrester 2016-06-03 15:30:03 UTC 
*** Bug 1342580 has been marked as a duplicate of this bug. ***
Comment 5 Yadan Pei 2016-06-07 04:54:53 UTC 
Checked against 

openshift v3.2.1.1-1-g33fa4ea
kubernetes v1.2.0-36-g4a3f9c5
etcd 2.2.5

Here is my verification steps:
1. cat help-links.js
window.OPENSHIFT_CONSTANTS.HELP['get_started_cli'] = "https://example.com/doc1.html";
window.OPENSHIFT_CONSTANTS.HELP['default'] = "https://example.com/doc2.html";

2. Edit /etc/origin/master/master-config.yaml adding extensionScripts section under assetConfig 

assetConfig:
  extensionScripts:
    - /path/to/help-links.js
3. Restart atomic-openshift-master service
# systemctl restart atomic-openshift-master
4. Login to web console

Documentation links on these pages(console/about page;help info on /console page when there is no project; help dropdown menu) is pointing to https://example.com/doc2.html 

It could be customized rather than hard coded, so move to VERIFIED
Comment 7 errata-xmlrpc 2016-06-27 15:07:15 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2016:1343
Note You need to log in before you can comment on or make changes to this bug.