Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1077542

Summary: Bussines Resource Documentation mentions invalid API's and makes incorrect statements
Product: [Retired] JBoss BRMS Platform 6 Reporter: Geoffrey De Smet <gdesmet>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED CURRENTRELEASE QA Contact: jvahala
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: high    
Version: 6.0.1CC: brms-docs, lpetrovi, mwinkler, rrajasek
Target Milestone: CR1   
Target Release: 6.1.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2015-04-16 21:56:29 UTC Type: Bug
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: 996104    
Bug Blocks:    
Attachments:
Description Flags
screenshot none

Description Geoffrey De Smet 2014-03-18 08:33:03 UTC
I took the content of the staged BRMS 6 planner guide:
  http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BRMS/6.0/html-single/Business_Resource_Planner_Guide/index.html

and also the content of the community 6.0.1 guide released a few months ago:
  http://docs.jboss.org/drools/release/6.0.1.Final/optaplanner-docs/html_single/index.html

I copy pasted the content of both in a file and then used meld to compare both, while ignoring white space (which is an option in meld's UI).

The BRMS 6 planner is full of bugs. Some examples:

- Description of the problem
BRMS 6 guide (incorrect)
=>
OptaPlanner community guide (correct)


- Usage of invalid API's THAT DO NOT COMPILE:
    @ValueRange(type = ValueRangeType.FROM_SOLUTION_PROPERTY, solutionProperty = rowList")
    public Row getRow() {
=>
    @PlanningVariable(valueRangeProviderRefs = {"rowRange"})

- Usage of namespace org.drools.planner:
<planningEntityClass>org.drools.planner.examples.nqueens.domain.Queen</planningEntityClass>
=>
<planningEntityClass>org.optaplanner.examples.nqueens.domain.Queen</planningEntityClass>

- Incomplete sentences:
That Collection must not contain the value null, even for a .
=>
That Collection must not contain the value null, even for a nullable planning variable.

- Missing links causing incomplete sentences:
See for more information.
=>
See sorted selection for more information.

- All (or almost all) internal links in the document are broken:
info: Log every phase and the solver itself. See .
=>
info: Log every phase and the solver itself. See scope overview.

- Invalid interface/API listings:
    void beforeAllVariablesChanged(Object entity);
=>
    void beforeVariableChanged(Object entity, String variableName);

- Stale project names:
Store and release in the Guvnor repository 
=>
Store and release in the KIE Workbench repository

- Use of deprecated, slow API's:
        insertLogical(new UnweightedConstraintOccurrence("multipleQueensHorizontal", $q1, $q2));
=>
        scoreHolder.addConstraintMatch(kcontext, -1);



This is just the tip of the iceberg. Use the meld procedure described above to find them all.

Comment 1 Geoffrey De Smet 2014-03-18 08:40:00 UTC
Created attachment 875834 [details]
screenshot

Comment 3 Geoffrey De Smet 2014-03-18 08:46:13 UTC
See screenshot to get an indication how many issues there really are.

Comment 4 Vikram Goyal 2015-01-22 05:13:10 UTC
The latest synced guide for BPMS/BRMS is now available here for 6.1 [1].

Moving this bug to ON_QA.

[1] http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.1/html-single/Business_Resource_Planner_Guide/index.html

Comment 5 jvahala 2015-03-18 12:11:11 UTC
Documentation seem up to date. Verified