Bug 1458383

Summary: [RFE] Administer -> About page should have a bullet link to the local Satellite API docs
Product: Red Hat Satellite Reporter: Mike McCune <mmccune>
Component: APIAssignee: Marek Hulan <mhulan>
Status: CLOSED ERRATA QA Contact: Lukáš Hellebrandt <lhellebr>
Severity: medium Docs Contact:
Priority: medium    
Version: 6.3.0CC: bkearney, ehelms, lhellebr, mhulan, sshtein, tstrachota, zhunting
Target Milestone: 6.4.0Keywords: EasyFix, FutureFeature
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: foreman-theme-satellite- Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-16 15:27:35 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Mike McCune 2017-06-02 17:46:14 UTC
Currently the documentation has links to the user guide, transition guide and the API guide, but we need a link to the local, Satellite specific APIDOCs found at:



 * User Guide
 * Transition Guide
 * API Guide
 * API Documentation

This will ensure the user can quickly know of and get to the correct API docs for the version they are using.

Comment 2 Marek Hulan 2017-06-16 14:10:05 UTC
Created redmine issue http://projects.theforeman.org/issues/20035 from this bug

Comment 3 Satellite Program 2017-06-16 16:01:25 UTC
Upstream bug assigned to mhulan

Comment 4 Satellite Program 2017-06-16 16:01:29 UTC
Upstream bug assigned to mhulan

Comment 5 Satellite Program 2017-06-20 12:01:20 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/20035 has been resolved.

Comment 6 Lukáš Hellebrandt 2018-06-25 11:56:24 UTC
This fix is not present in Sat 6.4 snap 8. The 'Documentation' section only contains link to 'Complete Product Documentation for Red Hat Satellite'.

(This is also true for Sat 6.3.1 but if this BZ's first sentence is right, it is a regression against Sat 6.3.)

Comment 15 Lukáš Hellebrandt 2018-08-29 08:34:45 UTC
Verified with Sat 6.4 snap 19.

Administer -> About page now contains the "API Resources" link leading to "https://intel-wildcatpass-05.khw.lab.eng.bos.redhat.com/apidoc" which contains API v2 documentation.

Comment 17 errata-xmlrpc 2018-10-16 15:27:35 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.