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/
Link: Added: This issue depends BRMS-284
Link: Added: This issue is a dependency of BRMS-280
Link: Removed: This issue is a dependency of BRMS-280
Link: Added: This issue depends BRMS-280
Attachment: Added: seperate.png
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.
Assigning back to Darrin for final edits - also - please see linked JIRAs.
Attachment: Added: figure4-1.png
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
also will correct spelling of seperate in image
Complete except: 3 and 5
3 - done
5 - done
Section 2.4.2 still refers to: http://www.jboss.com/products/platforms/brms/testedconfigurations/ this should be: http://www.jboss.com/products/platforms/brms/supportedconfigurations/
Link: Added: This issue depends BRMS-233
The screenshots in chapter 4 should be cropped to only include the BRMS windows.
Attachment: Added: desktop_image.png
One more instance of the wrong URL for supported configurations: http://downtown.englab.bne.redhat.com/drafts/JBoss_Enterprise_BRMS_Platform/5.0.2/BRMS_Userguide/html-single/#appe-example_persistence_manager_config Refers to: http://www.jboss.com/products/platforms/brms/testedconfigurations/ Should refer to: http://www.jboss.com/products/platforms/brms/supportedconfigurations/
updated (keep forgetting to resolve)