Bug 1342580 - Overriding Documentation link in Web Console has no effect
Summary: Overriding Documentation link in Web Console has no effect
Keywords:
Status: CLOSED DUPLICATE of bug 1336526
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Management Console
Version: 3.2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Jessica Forrester
QA Contact: Yadan Pei
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-03 14:59 UTC by Brendan Mchugh
Modified: 2019-11-14 08:15 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-06-03 15:30:03 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Brendan Mchugh 2016-06-03 14:59:19 UTC
Description of problem:

Trying to override the Documentation link in the Nav Bar of the Web Console has no effect.

Using the following guide:
https://docs.openshift.com/enterprise/3.2/install_config/web_console_customization.html#changing-links-to-documentation

Trying to modify the following window.OPENSHIFT_CONSTANTS

"default":"https://docs.openshift.org/latest/welcome/index.html"


Version-Release number of selected component (if applicable):
openshift v3.2.0.44
kubernetes v1.2.0-36-g4a3f9c5
etcd 2.2.5


How reproducible:
Always


Steps to Reproduce:
1. Create help-links.js with following content:

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 with systemctl restart atomic-openshift-master.service
4. Login to Web Console
5. Click on Help button, hover over documentation


Actual results:
Documentation link still points to "https://docs.openshift.org/latest/welcome/index.html"

Expected results:
Documentation link should point to the URL set in extensionScripts section "https://example.com/doc2.html"


Additional info:
Is the URL in the WebConsole/Help/Documentation link coming from the window.OPENSHIFT_CONSTANTS?

If not, how to override?

Comment 1 Jessica Forrester 2016-06-03 15:30:03 UTC
There was a bug with the link in the help dropdown, it had a hardcoded URL, the fix is targeted for 3.2.1.  All other doc links in the console should be correctly customized.

*** This bug has been marked as a duplicate of bug 1336526 ***


Note You need to log in before you can comment on or make changes to this bug.