Skip to content

Commit e23d22d

Browse files
committed
Refactor documentation
1 parent 16a04f5 commit e23d22d

File tree

2 files changed

+15
-26
lines changed

2 files changed

+15
-26
lines changed

docs/asciidoc/getting-started.adoc

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
1+
[[GettingStarted]]
12
== Getting Started
23

4+
This quick start tutorial sets up a single node RabbitMQ and runs the sample reactive sender and consumer using Reactive Commons.
5+
6+
37
[[Requirements]]
48
=== Requirements
59

610
You need Java JRE installed (Java 8 or later).
711

812
You also need to install RabbitMQ. Follow the
913
https://www.rabbitmq.com/download.html[instructions from the website].
10-
Note you should use RabbitMQ 3.6.x or later.
11-
12-
=== Quick Start
13-
14-
This quick start tutorial sets up a single node RabbitMQ and runs the sample reactive
15-
sender and consumer using Reactive Commons.
1614

1715
==== Start RabbitMQ
1816

@@ -37,20 +35,17 @@ Also you need to include the name for your app in the application.properties:
3735
--------
3836
spring.application.name=MyAppName
3937
--------
40-
Or yaml
38+
Or yaml format
4139
[source, yaml]
4240
--------
4341
spring:
4442
application:
4543
name: myAppName
4644
--------
4745

48-
The https://github.com/reactor/reactor-rabbitmq/blob/master/reactor-rabbitmq-samples/src/main/java/reactor/rabbitmq/samples/SpringBootSample.java[`SpringBootSample`]
49-
code is on GitHub.
50-
5146
===== DomainEventBus
5247

53-
You must enable DomainEventBus with the @EnableDomainEventBus annotation. It give you a bean DomainEventBus, which let you, to emit and listen messages like DomainEvent type.
48+
You must enable DomainEventBus with the @EnableDomainEventBus annotation. It give you a DomainEventBus bean for emitting and listenning messages.
5449

5550
===== DomainEvent Class
5651
The DomainEvent class has the following structure:
@@ -63,15 +58,7 @@ public class DomainEvent<T> {
6358
private final String name;
6459
private final String eventId;
6560
private final T data;
66-
67-
public DomainEvent(String name, String eventId, T data) {
68-
this.name = name;
69-
this.eventId = eventId;
70-
this.data = data;
71-
}
72-
7361
//... getters, equals, hascode, toString impl..
74-
7562
}
7663
--------
7764

docs/asciidoc/overview.adoc

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,19 @@ avoiding unnecessary intermediate buffering or blocking.
2828
=== Reactive API for Event Mechanism
2929

3030
Reactive Commons is a reactive API for asyncronous message driven communication based on Reactor.
31-
Reactive Commons API enables messages to be published over RabbitMQ or SNS/SQS and consumed from those products using functional APIs with non-blocking back-pressure and low overheads.
32-
This enables applications using Reactor to use RabbitMQ or SNS/SQS as a message bus, integrating with other systems to provide an end-to-end reactive system.
31+
Reactive Commons API enables messages to be published over a event bus like RabbitMQ or SNS/SQS and consumed using functional APIs with non-blocking back-pressure and low overheads.
32+
It enables applications using Reactor to use RabbitMQ or SNS/SQS as a message bus, integrating it with other systems to provide an end-to-end reactive system.
3333

34-
When we talk about asyncronous message driven communication, we can use several sematic ways to use the term "message". So, we can talk about Events and Commands.
34+
When we talk about asyncronous message driven communication, we can use several sematic ways to use the term "message". So, we can talk about Events, Commands and Queries.
3535

3636
==== Events - Pub/Sub
37-
Events represent a fact inside the domain, it is the representation of a decision or a state change that a system want to notify to its subscriptors. Events represents facts in the past, so events are not intentions or requests of anything in present, for example: "UserRegistered", "NotificationSent".
37+
Events represent a fact inside the domain, it is the representation of a decision or a state change that a system want to notify to its subscribers. Events represents facts that nobody can change, so events are not intentions or requests of anything, An example may be and UserRegistered or a NotificationSent.
3838

39-
Events are the most important topic in a Publish-Subscribe system, because this element let us to notify a many stakeholders in a specific event. An other benefit is system is decouple, because you can add more subscriber to the system without modify some component.
39+
Events are the most important topic in a Publish-Subscribe system, because this element let's notify a many stakeholders in a specific event. An other benefit is the system is decouple, because you can add more subscriber to the system without modify some component.
4040

4141
==== Commands
42-
Commands represent a intention for doing something, that intention must to be doing by the domain context with that responsibility. An example of a command may be: "registerUser", "sendNotification".
42+
Commands represent a intention for doing something, that intention must to be done by the domain context with that responsibility. An example of a command may be: "registerUser" or "sendNotification".
4343

44-
==== Request / Reply
44+
==== Request / Reply
45+
46+
Queries represent a intention for getting information about something, that query must to be processed by the domain context with that responsibility and that context must respond with the information requested throught request/reply pattern. An example of a query may be: "UserInfo".

0 commit comments

Comments
 (0)