Bug 773693

Summary:	Incorrect/Misleading Expert Documentation For Drools XML Language
Product:	[JBoss] JBoss Enterprise BRMS Platform 5	Reporter:	Justin Holmes <justinmichaelholmes>
Component:	doc-BRMS_Rules_Reference_Guide	Assignee:	lcarlon <lcarlon>
Status:	CLOSED DUPLICATE	QA Contact:	Andrew Ross <anross>
Severity:	low	Docs Contact:
Priority:	unspecified
Version:	unspecified	CC:	brms-jira, mdoyle
Target Milestone:	---
Target Release:	---
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-02-17 00:24:13 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:

Description Justin Holmes 2012-01-12 15:58:09 UTC

Description of problem: The Drools XML language "...has not been developed since drools 4.0, and is considered a deprecated feature." However, the docs for 5.x versions of Drools clearly state, "All the features are available with XML that are available to DRL." As such,the docs need to be updated to reflect the current state of the XML language so users are not mislead.

A simple yellow Warning box at the beginning of the XML section stating that the XML hasn't been developed since 4.0 and is consider deprecated will be enough to properly inform users. Removing the "All features..." would be useful as well.

I'm planning to provided a pull request in the next week or so.



Version-Release number of selected component (if applicable): 5.x


Additional info:

http://article.gmane.org/gmane.comp.java.drools.user/29310/match=xml+language

http://docs.redhat.com/docs/en-US/JBoss_Enterprise_BRMS_Platform/5/html-single/JBoss_Rules_5_Reference_Guide/index.html#sect-XML_Rule_language

Comment 1 lcarlon 2012-01-16 01:50:19 UTC

Thanks Justin.

I've removed the offending section from the JBoss Rules Reference Guide. The changes will be apparent when we publish the BRMS 5.3 documentation.

Thanks
Lee

Comment 2 Justin Holmes 2012-01-17 22:33:59 UTC

Hello Lee,

Will this change be ported to all 5.x versions of the community documentation as well?

Comment 3 lcarlon 2012-01-17 22:54:38 UTC

Hi Justin,

the only changes I've made are to the product documentation.

Thanks
Lee

Comment 4 lcarlon 2012-02-17 00:24:13 UTC


*** This bug has been marked as a duplicate of bug 742185 ***

Comment 5 JBoss JIRA Server 2012-04-02 04:02:59 UTC

Mark Proctor <mark.proctor> updated the status of jira JBRULES-3342 to Resolved

Comment 6 JBoss JIRA Server 2012-04-02 04:03:08 UTC

Mark Proctor <mark.proctor> updated the status of jira JBRULES-3342 to Closed