Bug 790244

Summary:	topic text appears under specific secondary tags
Product:	[Community] PressGang CCMS	Reporter:	Misha H. Ali <mhusnain>
Component:	Web-UI	Assignee:	Matthew Casperson <mcaspers>
Status:	CLOSED CURRENTRELEASE	QA Contact:
Severity:	high	Docs Contact:
Priority:	high
Version:	1.x	CC:	cbredesen, lnewson, topic-tool-list
Target Milestone:	---
Target Release:	---
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:	Cause The DocbookBuilderThread.buildLandingPageTopic() method can search the database for topics that match the tech name, concern and Tag Description tags, to use in populating the landing pages. The REST query for this search was not formatted properly, meaning that the tech name was not being used to limit the results. Consequence This resulted in the topics with just the concern (getting started in this case) and the Tag Description tag applied being used as the template for the landing pages. Fix The query is now properly formatted. Result The landing pages now do not display the contents from unrelated topics.	Story Points:	---
Clone Of:		Environment:
Last Closed:	2013-06-07 01:50:46 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Deadline:	2012-03-01

Description Misha H. Ali 2012-02-14 01:56:19 UTC

Description of problem:

For every Common Name, the Getting Started page contains what appears to be the text from a CDI topic. Examples:

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Data_Grid/6/html/Beta_Documentation/TopicID-29.html

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Data_Grid/6/html/Beta_Documentation/TopicID-49.html

How reproducible:

100%

Steps to Reproduce:
1. Navigate to: http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Data_Grid/6/html/Beta_Documentation/index.html
2. Click any primary tag (Common Name) to expand.
3. Click the Getting Started secondary tag.
4. View what appears to be the contents of a CDI topic appearing at the top of the page. 
  
Actual results:

CDI topic text appears in every Getting Started page.

Expected results:

No text unless otherwise provided in every Getting Started page.

Additional info:

EDG docs do not have a CDI topic nor is one meant to be included in the filter used (MHA-EDG6Beta).

Comment 1 Misha H. Ali 2012-02-14 02:05:23 UTC

Correction, this appears to be happening for EAP documentation as well and not just for the Getting Started tag. Examples:

* Application Development Tag: (this one appears to be intention, maybe?)
http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/TopicID-7.html

* Installation Tag: (also probably intentional?)
http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/TopicID-32.html

* Configuration Tag: (this one may also be intentional, but is EAP specific)
http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/TopicID-83.html

* Data Sources (this one seems relevant to the secondary tag, so not sure if this was intended to appear)
http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Application_Platform/6/html/Beta_Documentation/TopicID-63.html

Comment 2 Misha H. Ali 2012-02-14 02:08:15 UTC

While many of the above appear to include text that is relevant to the tags (in the context of EAP6 at least), the fact that they appear everywhere said tag is used is not desired. For example, within the EDG documentation:

http://documentation-stage.bne.redhat.com/docs/en-US/JBoss_Enterprise_Data_Grid/6/html/Beta_Documentation/TopicID-20.html

Also, the CDI information in Getting Started appears to be unintentional, at least.

Comment 3 Misha H. Ali 2012-02-16 05:32:32 UTC

After a discussion with misty, it seems that the landing page for each of these concerns should have customizable text. This addresses one of the issues in this bug. The second is that the CDI text for some odd reason appears under the Getting Started concern's landing page. This seems random and is most certainly not required.

Comment 4 Matthew Casperson 2012-02-17 01:01:24 UTC

Fixed in 20120217-0922

Comment 5 Matthew Casperson 2012-02-17 01:01:24 UTC

    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
Cause
The DocbookBuilderThread.buildLandingPageTopic() method can search the database for topics that match the tech name, concern and Tag Description tags, to use in populating the landing pages. The REST query for this search was not formatted properly, meaning that the tech name was not being used to limit the results.

Consequence
This resulted in the topics with just the concern (getting started in this case) and the Tag Description tag applied being used as the template for the landing pages.

Fix
The query is now properly formatted.

Result
The landing pages now do not display the contents from unrelated topics.