Formatting example rule-camel-cbr #283

Closed
wants to merge 1 commit into from

4 participants

@hannelita

No description provided.

@rafabene rafabene commented on the diff Oct 29, 2013
rules-camel-cbr/pom.xml
<modelVersion>4.0.0</modelVersion>
+
<parent>

I was wondering that as all other quickstarts, we should make this "standalone" which means that we should be able to build it without the parent pom.xml.

We probably need to remove parent's reference

@kcbabo
jboss-switchyard member
kcbabo added a note Nov 6, 2013

This would be a change for the forked quickstart repo in the JDF account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@paulrobinson paulrobinson commented on the diff Oct 30, 2013
rules-camel-cbr/README.md
-Running the quickstart
-======================
JBoss AS 7

This section seems redundant now. It looks to be covered by "Build and Deploy the Quickstart". Maybe it should be removed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@paulrobinson

The image file "rules-camel-cbr.jpg" in the root of the quickstart doesn't seem to be used. Should we include it in the readme as part of the "What is it?" section? I think it would help visualize what the QS is doing.

@paulrobinson paulrobinson commented on the diff Oct 30, 2013
rules-camel-cbr/README.md
This quickstart also demonstrates the ability to use MVEL expressions to extract objects (the Widgets from their Boxes) and insert them as facts inside the rules engine.
+
The drl resource is specified using annotations within the DestinationServiceRules interface, and checks the id of Widgets to determine the destination to set on their Boxes.

Is it expected that a reader of this quickstart would know what a "drl resource" is? I guess we can't explain every detail, and we do need to assume some prior knowledge. Maybe we could clarify this in parentheses? Something like:

The drl resource (drools rule file) is specified...

I'm not sure on the right terminology for describing what a "drl resource" is, but hopefully this gives you an idea of what I'm thinking.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@rafabene rafabene commented on the diff Oct 30, 2013
rules-camel-cbr/README.md
-Preqrequisites
-==============
-Maven
+Before building and running this quick start you need:
+
+* Maven 3.0.3 or higher
+* JDK 1.6 or 1.7
+* JBoss AS 7

Shouldn't this list be changed from AS 7 to FSW ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
@kcbabo
jboss-switchyard member

Apologies for the late comments on this PR.

1) I went back and reviewed our last email discussion w/r/t migrating the SY quickstarts to JDF and it was decided that project quickstarts would be forked into the JDF account so that changes not appropriate for the project version could be made separately. Based on the content and comments of this PR, I would say the following should be done in the forked version of the repo and not directly in the project:

  • Java package name changes
  • GAV changes
  • Removing parent definition

2) The image is pretty useful and should be referenced by the README, IMO. Here's an example of how it looked pre-migration:
https://github.com/jboss-switchyard/quickstarts/blob/master/rules-camel-cbr/Readme.md

3) I'm good with all other changes.

@rafabene

I think this PR was replaced by #300 right ?

@paulrobinson

In part. The changes to the readme.md, are not done in #300.

@kcbabo kcbabo closed this Jan 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment