Bug 703362

Summary:	Topics are incorrectly identified as failing validation and don't show up in nav pages
Product:	[Community] PressGang CCMS	Reporter:	Joshua Wulf <jwulf>
Component:	Web-UI	Assignee:	Joshua Wulf <jwulf>
Status:	CLOSED CURRENTRELEASE	QA Contact:
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	1.x	CC:	lcarlon, topic-tool-list
Target Milestone:	---	Keywords:	Reopened
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2011-05-18 05:30:34 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Joshua Wulf 2011-05-10 06:57:25 UTC

Topic 902: http://jboss-eap.bne.redhat.com:8080/TopicIndex/Topic.seam?topicTopicId=902&cid=35

This topic does not have an SVN URL.

The latest EAP6 wireframe incorrectly identifies it as failing validation: 
http://jboss-eap.bne.redhat.com//EAP6_wireframe/PlaceholderXRef700.html

This is not correct. It looks like there is something wrong with the builder logic there.

Additionally, it looks like topics that are identified by the builder as failing validation (rightly or wrongly), are not included in nav pages. For example, topic 902 does appear here:
http://jboss-eap.bne.redhat.com//EAP6_wireframe/TertiaryNavPage-1-50.html

It should be listed here, even if it were failing validation (which it shouldn't be in this case).

So two problems:
1. Topic incorrectly identified as failing validation.
2. Topic identified as failing validation not included in wireframe.

The test case for 1 is obviously that 902 gets included in a build.

For 2, we need a topic that we know is broken and does not validate. It should be flagged as not validating in the output *and* it should be listed in the relevant navigation views.

We may need to create a handful of test topics to use as controls for unit tests.

Comment 1 Matthew Casperson 2011-05-10 20:10:58 UTC

All topics need 1 (and only 1) topic type tag assigned to them, 1 or more technology tags and 1 or more concern tags. Without these constraints it makes it very difficult to determine the xrefs for the nav pages (i.e. you will end up with publican build errors).

Topics that fail this validation are not included in the nav pages as their tags can not be determined. This is by design. They are included in the documentation build however, and can be found under the "Error Topics" chapter.

Comment 2 Joshua Wulf 2011-05-13 11:34:06 UTC

Can we make the inline error message more precise in that case?

At the moment "failed validation" can mean one of two things - either source xml for the topic exists and failed validation, *or* the topic metadata does not contain all the necessary information to build it.

The compiler error message is more descriptive.

So:

Can we leave the inline error message as it is for failed xml validation, and add a different error message for incomplete meta-data:

"This topic is not tagged with all the meta-data needed to build."

So the above error message is the one that I would see if I went to, for example:
http://jboss-eap.bne.redhat.com/EAP6/wireframe/130511/PlaceholderXRef2576.html

Comment 3 Matthew Casperson 2011-05-16 03:08:46 UTC

Fixed in 20110516-1246

Comment 4 Joshua Wulf 2011-05-18 01:50:24 UTC

The error message text is now accurate, but the title still needs to be changed:

http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/PlaceholderXRef700.html

Error title should be: "Topic meta-data incomplete"

Comment 5 Matthew Casperson 2011-05-18 03:16:40 UTC

Fixed in 20110518-1257

Comment 6 Joshua Wulf 2011-05-18 05:30:34 UTC

Verified: http://jboss-eap.bne.redhat.com/wireframes/EAP6/110518/PlaceholderXRef181.html