Bug 724340 (BRMS-285) - QE: BRMS User Guide
Summary: QE: BRMS User Guide
Keywords:
Status: CLOSED NEXTRELEASE
Alias: BRMS-285
Product: JBoss Enterprise BRMS Platform 5
Classification: JBoss
Component: Documentation
Version: 5.0.2
Hardware: Unspecified
OS: Unspecified
high
unspecified
Target Milestone: ---
: 5.0.2
Assignee: Len DiMaggio
QA Contact:
URL: http://jira.jboss.org/jira/browse/BRM...
Whiteboard:
Depends On: BRMS-233 BRMS-280 BRMS-284
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-03-30 01:12 UTC by Dana Mison
Modified: 2010-09-03 14:20 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2010-09-03 14:20:31 UTC
Type: Task
Embargoed:


Attachments (Terms of Use)
seperate.png (326.76 KB, image/png)
2010-04-05 13:19 UTC, Len DiMaggio
no flags Details
figure4-1.png (200.35 KB, image/png)
2010-04-05 15:43 UTC, Len DiMaggio
no flags Details
desktop_image.png (444.11 KB, image/png)
2010-04-16 14:51 UTC, Len DiMaggio
no flags Details


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker BRMS-285 0 None None None Never

Description Dana Mison 2010-03-30 01:12:46 UTC
Affects: Documentation (Ref Guide, User Guide, etc.)
Date of First Response: 2010-04-05 11:41:56
securitylevel_name: Public

Draft doc at: 
http://downtown.englab.bne.redhat.com/drafts/JBoss_Enterprise_BRMS_Platform/5.0.2/BRMS_Userguide/

Comment 1 Len DiMaggio 2010-03-30 01:16:56 UTC
Link: Added: This issue depends BRMS-284


Comment 2 Len DiMaggio 2010-03-30 14:09:50 UTC
Link: Added: This issue is a dependency of BRMS-280


Comment 3 Len DiMaggio 2010-04-05 11:36:52 UTC
Link: Removed: This issue is a dependency of BRMS-280 


Comment 4 Len DiMaggio 2010-04-05 11:37:19 UTC
Link: Added: This issue depends BRMS-280


Comment 5 Len DiMaggio 2010-04-05 13:19:40 UTC
Attachment: Added: seperate.png


Comment 6 Len DiMaggio 2010-04-05 15:41:56 UTC
Comments:

=================================

Figure 4.1. Main feature areas of the BRMS Platform
The above picture shows the main feature areas of the BRMS Platform.
• Info: This is the initial screen, with links to resources.
• Rules: This is the category and business user perspective.
• Package: This is where packages are configured and managed.
• Deployment: this is where deployment snapshots are managed.
• Admin: Administrative functions (categories, statuses, import and export)

Comment: The image in figure 4-1 is truncated and the bulleted items do not match the screen display

=================================

Chapter 5 - The note that refers to:

JBoss only provides support for this functionality in the JBoss Developer Studio 2 product.

Should refer to:

JBoss provides support for this functionality in the JBoss Developer Studio 2 and 3 products.

=================================

The first reference to Guvnor in the book is on page 4:

Note
These instructions tell you to use the URL http://<server>:8080/jboss-brms/ to
access the BRMS application. However, that URL is just a convenience and it
actually redirects your browser to the full URL, http://<server>:8080/jboss-brms/
org.drools.guvnor.Guvnor/Guvnor.html. You can use the full URL if you wish.

But - the explanation of the relationship between Guvnor and BRMS is not explained until page 53:

Important
Guvnor is the name of the open-source project on which the JBoss Enterprise BRMS
Platform has been built. The Eclipse Guvnor Tools were developed with it in mind. Any
place where EGT refers to "Guvnor" it can be considered equivalent to "BRMS Platform".
To avoid confusion the remainder of this chapter will use term "Guvnor".

Comment: We should add this note to page 4:

Important
Guvnor is the name of the open-source project on which the JBoss Enterprise BRMS
Platform has been built.

=================================

I think that it is worth defining DRL (Drools Rule Language - the "native" Drools rule language) and DSL (Domain Specific Languages - a way of extending the rule language to your problem domain) fo rth efirst time user/reader.

=================================

4.6.1. The Rule Agent
The Rule Agent is a component which is embedded in the core run-time of the Rules Engine. In order
to use it, you do not need any extra components. In fact, if you are using the BRMS Platform, your
application should only need to include the drools-core dependencies in its classpath (drools
and mveljars only). There are no other rule-specific dependencies.

Comment: We should refer the user to the "README_DEPENDENCIES.txt" file that is included in jboss-brms-engine.zip

Note that there is also a drools-ant ant task...

Comment: drools-ant-5.0.1.BRMS.jar is also included in: jboss-brms-engine.zip

=================================

4.6.1. The Rule Agent

The code fragment should also include:

import org.drools.agent.RuleAgent;
import org.drools.RuleBase;

=================================

Task to think about - not in the context of a point release - re-organizing the guide. Chapter 4 is named the "Quickstart Guide," but it is over 25 pages long. I'm thinking that we should redesign the guide and convert this long chapter into a set of shorter chapters where each chapter covers one task or use case.




Comment 7 Len DiMaggio 2010-04-05 15:42:42 UTC
Assigning back to Darrin for final edits - also - please see linked JIRAs.

Comment 8 Len DiMaggio 2010-04-05 15:43:09 UTC
Attachment: Added: figure4-1.png


Comment 9 Dana Mison 2010-04-06 08:05:51 UTC
Items 1-7:
1 - already covered by BRMS-233
2 - JBDS 3 - will update
3 - will move these comments to the introduction of the book
4 - will add definitions to first usages
5 - will investigate, needs some clarification
6 - will update
7 - that is something that needs to occur upstream.  The first section of the chapter is also called Quickstart Guide and actually *is* a quickstart guide.  The chapter just needs renaming to something more appropriate

Comment 10 Dana Mison 2010-04-06 08:06:41 UTC
also will correct spelling of seperate in image

Comment 11 Dana Mison 2010-04-12 07:31:17 UTC
Complete except: 3 and 5

Comment 12 Dana Mison 2010-04-16 03:41:23 UTC
3 - done

Comment 13 Dana Mison 2010-04-16 06:27:06 UTC
5 - done

Comment 15 Len DiMaggio 2010-04-16 14:44:34 UTC
Link: Added: This issue depends BRMS-233


Comment 16 Len DiMaggio 2010-04-16 14:51:50 UTC
The screenshots in chapter 4 should be cropped to only include the BRMS windows.

Comment 17 Len DiMaggio 2010-04-16 14:51:50 UTC
Attachment: Added: desktop_image.png


Comment 19 Dana Mison 2010-05-06 01:06:14 UTC
updated (keep forgetting to resolve)


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