From 1c94075cf87a1e443c018df062092a2473043bd4 Mon Sep 17 00:00:00 2001 From: Mahmoud Ben Hassine Date: Thu, 25 Jun 2015 08:59:10 +0200 Subject: [PATCH] polish documentation --- site/about/getting-started.md | 12 +++++------- site/tutorials/dynamic-configuration.md | 10 +--------- site/user-guide/introduction.md | 4 ++-- 3 files changed, 8 insertions(+), 18 deletions(-) diff --git a/site/about/getting-started.md b/site/about/getting-started.md index 4760bf8..1401bf2 100644 --- a/site/about/getting-started.md +++ b/site/about/getting-started.md @@ -30,13 +30,11 @@ Easy Rules is a single jar file with no dependencies. You have to add the jar ** If you use maven, you should add the following dependency to your **_pom.xml_** : ```xml - - - org.easyrules - easyrules-core - {{site.version}} - - + + org.easyrules + easyrules-core + {{site.version}} + ``` ## Quick start archetype diff --git a/site/tutorials/dynamic-configuration.md b/site/tutorials/dynamic-configuration.md index 62c21f5..64c34ce 100644 --- a/site/tutorials/dynamic-configuration.md +++ b/site/tutorials/dynamic-configuration.md @@ -10,7 +10,7 @@ doc: true In this tutorial, we have an online shop application and we would like to implement the following requirements: 1. Whenever a new customer places an order with an amount greater than a defined threshold, send an alert about this suspect order to the monitoring team. -2. Moreover, the order amount threshold should be reconfigurable via JMX so we can change it at runtime. +2. Moreover, the order amount threshold should be configurable via JMX so we can change it at runtime. In the first part of this tutorial, we will see how to use Easy Rules to implement the business rule described in requirement #1. @@ -22,26 +22,18 @@ In this application, orders and customers are represented by the _Order_ and _Cu ```java class Order { - private long orderId; - private float amount; - //getters and setters - } ```
```java class Customer { - private long customerId; - private boolean isNew; - //getters and setters - } ``` diff --git a/site/user-guide/introduction.md b/site/user-guide/introduction.md index e78a51b..57d08e7 100644 --- a/site/user-guide/introduction.md +++ b/site/user-guide/introduction.md @@ -7,7 +7,7 @@ next_section: user-guide/defining-rules doc: true --- -Most business rules can be represented by the following rule definition: +Most business rules can be represented by the following definition: * _Name_: a unique rule name within a rules namespace * _Description_: a brief description of the rule @@ -15,7 +15,7 @@ Most business rules can be represented by the following rule definition: * _Conditions_: set of conditions that should be satisfied to apply the rule * _Actions_: set of actions to perform when conditions are satisfied -Easy Rules provides an abstraction for each of these key points that define a business rule. +Easy Rules provides an abstraction for each of these key points to define business rules. Next section will show you how to define a rule either by extending a base class provided by Easy Rules or by annotating your own domain class.