Bug 244759

Summary: Config Management File pages have too generic of a help link
Product: Red Hat Satellite 5 Reporter: Mike McCune <mmccune>
Component: UsabilityAssignee: Máirín Duffy <duffy>
Status: CLOSED CURRENTRELEASE QA Contact: Preethi Thomas <pthomas>
Severity: low Docs Contact:
Priority: low    
Version: unspecified   
Target Milestone: ---   
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: sat510 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2008-04-03 00:24:24 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 248627    
Attachments:
Description Flags
list of pages => context links none

Description Mike McCune 2007-06-19 00:52:54 UTC
Go to:

1) configuration
2) go to a config channel
3) view a file so you are looking at:

/rhn/configuration/file/FileDetails.do?cfid=XXX

4) note the help link goes to:

/help/reference/s1-sm-channels-packages.html#S2-SM-CONFIG-MANAGE

but we have specific sections in the docs for this:

<a name="S3-SM-FILE-DETAILS">6.6.6.6. Configuration File Details — 

in the above mentioned html page.

Comment 1 Mike McCune 2007-06-19 00:54:17 UTC
Will need to better parameterize the help links in the jspf:

<%@ include file="/WEB-INF/pages/common/fragments/configuration/files/header.jspf"%>

to pass in a help-link param or something along those lines.

Comment 2 Máirín Duffy 2007-11-01 23:42:25 UTC
Sending        common/fragments/configuration/files/header.jspf
Transmitting file data .
Committed revision 133445.

TESTPLAN
========
1) configuration
2) go to a config channel
3) view a file so you are looking at:

/rhn/configuration/file/FileDetails.do?cfid=XXX

4) note the help link should go to:
/help/reference/s1-sm-channels-packages.html#S3-SM-FILE-DETAILS

Comment 3 Preethi Thomas 2007-11-27 21:48:02 UTC
fails qa

it should be going to 
6.6.6.6. Configuration File Details —
https://rlx-0-10.rhndev.redhat.com/rhn/help/reference/en/s3-sm-file-details.jsp

but right now it goes to
6.6. Channels
https://rlx-0-10.rhndev.redhat.com/rhn/help/reference/en/s1-sm-channels-packages.jsp#S3-SM-FILE-DETAILS

Comment 4 Máirín Duffy 2007-11-28 13:37:21 UTC
Preethi, it looks like ALL of the context sensitive links are now broken. There
much have been a change in the way the docs are built or something that breaks
all of our links.

I filed bug 402711. I don't think this context link should be changed to this
new format and every single other one broken; I think if possible it would be
better to change the generated html of the docs to once again comply to the
format the web context sensitive links expect.

I am changing this bug to NEEDINFO and making it dependent on bug 402711.

Comment 5 Máirín Duffy 2008-02-08 19:17:16 UTC
Created attachment 294400 [details]
list of pages => context links

attaching list of pages, their suggested context links, separated by which
pages have good links and which have missing links or links that will change
when bug 402711 is fixed.

Comment 6 Máirín Duffy 2008-02-11 16:40:24 UTC
updating context-links based on current state of rhn 5.1 docs. 

TESTPLAN
=========

Please see attachment 294400 [details] in comment 5 for a list of the pages that should
have updated context help links. They should now be pointing the docs pages
referenced per page (or block of pages) in that file.

Comment 8 Pradeep Kilambi 2008-03-20 03:08:00 UTC
release pending

Comment 9 Brandon Perkins 2008-04-03 00:24:24 UTC
5.1 Sat GA so Closed for Current Release.