Bug 1154074 - Datasource description in installer points to old documentation
Summary: Datasource description in installer points to old documentation
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Installer
Version: 6.4.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: DR8
: EAP 6.4.0
Assignee: jboss-set
QA Contact: Petr Kremensky
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-10-17 13:02 UTC by Nikoleta Hlavickova
Modified: 2023-09-14 02:49 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-08-19 12:44:15 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1018657 0 unspecified CLOSED Links should point to latest documentation 2021-02-22 00:41:40 UTC

Internal Links: 1018657

Description Nikoleta Hlavickova 2014-10-17 13:02:04 UTC
Description of problem:
Datasource description in installer points to old documentation

Version-Release number of selected component (if applicable):
EAP 6.4.0.DR4

How reproducible:
always

Steps to Reproduce:
1. run EAP installer
2. on the Configure runtime environment screen select to Install JDBC driver
3. click the link "If your driver is not supported, click here"

Actual results:
https://access.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.3/html/Administration_and_Configuration_Guide/sect-Datasource_Configuration.html

Expected results:
Link to EAP 6.4 documentation

Additional info:
Please consult the new location with documentation team, it may not be https://access.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.4/html/Administration_and_Configuration_Guide/sect-Datasource_Configuration.html

Comment 1 Thomas Hauser 2014-10-17 14:57:04 UTC
I think for this issue, it's better to change our link to https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/ instead of the link we're currently using. Does this sound good Nikoleta?

Comment 3 sgilda 2014-11-03 18:10:27 UTC
Nikoleta is right. The 'JBoss Enterprise Application Platform' guides are being renamed to 'Red Hat JBoss Enterprise Application Platform' for 6.4.

I believed the URL in comment 2 is correct.

Thomas, if you have room, you can use the basic URL, but specify the book and section, for example: 

If your driver is not supported, see the 'Datasource Configuration' section of the `Administration and Configuration Guide' for Red Hat JBoss Enterprise Application Platform [located here: https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Enterprise_Application_Platform/].

If you don't have the space, you could turn the 'Administration and Configuration Guide' into a link.

Tom or Russell, do you know if the above links are correct or do you have a better suggestion?

Comment 4 Thomas Hauser 2014-12-02 16:37:17 UTC
I've changed the link to be https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Enterprise_Application_Platform/ . Note that this does not work yet since the Documentation is not staged.

Comment 5 Petr Kremensky 2014-12-05 08:21:57 UTC
Hey Tom I believe this could be moved to ON_QA.

Comment 6 Petr Kremensky 2014-12-08 08:38:50 UTC
I don't think we should point the link from 'Admininstration and Configuration Guide' to https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Enterprise_Application_Platform/ since it points to documentation index page not to A&C guide itself (the screen similar to https://access.redhat.com/documentation/en-US/JBoss_Enterprise_Application_Platform/).

---------------------------------
...
You can find examples for major databases in the 'Datasource Configuration' section of the EAP documentation, which can serve as a template for your definition.

EAP Documentation - [Admininstration and Configuration Guide|https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Enterprise_Application_Platform/]
---------------------------------

how about

---------------------------------
...
You can find examples for major databases in the 'Datasource Configuration' section of the Administration and Configuration Guide, which can serve as a template for your definition.

[EAP Documentation|https://access.redhat.com/site/documentation/en-US/Red_Hat_JBoss_Enterprise_Application_Platform/]
---------------------------------

Comment 7 Thomas Hauser 2014-12-09 16:55:54 UTC
Agreed Petr, will update the link for DR13.

Comment 8 Thomas Hauser 2014-12-09 16:59:06 UTC
Also I was told that we shouldn't be linking to chapters directly, but to the index page. Do you have any comments, Sande?

Comment 9 sgilda 2014-12-09 18:16:54 UTC
Thomas, that is my understanding. We point them to the chapter or section. 

Tom Wells, can you verify the above and also what the link for the JBoss EAP 6.4 documentation will be?

Comment 12 Thomas Hauser 2014-12-10 21:55:17 UTC
I've updated the string with another interim message until we get some feedback :)

Comment 13 Petr Kremensky 2014-12-12 07:05:24 UTC
Verified on EAP 6.4.0.DR13.

Hey Tom, I was just using jira syntax for making links, I wasn't trying to force you to use "|" as separator :), but I guess we can stay like this.

Comment 15 Red Hat Bugzilla 2023-09-14 02:49:11 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 1000 days


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