GitBook: [master] 20 pages modified

Elders · Oct 1, 2020 · 7026f5d · 7026f5d
1 parent e2a03ea
commit 7026f5d
Show file tree

Hide file tree

Showing 19 changed files with 102 additions and 34 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,10 @@
-# Initial page
+# Introduction
 
+Welcome to the Cronus Manual!
+
+Cronus provides the Cronus Framework to help build applications centered on three core concepts - CQRS \(Command Query Responsibility Segregation\) / Event Sourcing and DDD \(Domain Driven Design\).
+
+While many types of applications can be built using Cronus, it has proven to be very popular for microservices architectures. Cronus provides an innovative and powerful way of sensibly evolving to event-driven microservices within a microservices architecture.
 
 
-Usually you do not need a CQRS framework to develop greate apps. However, we noticed a common infrastructure code written with every applicaiton. We started to abstract and move that code to github. The key aspect was that even with a framework you still have full control and flexibility over the application code.
 
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -1,8 +1,27 @@
 # Table of contents
 
-* [Initial page](README.md)
-* [Configuration](configuration.md)
-* [Introduction](introduction.md)
-* [Index](index.md)
-* [test](test.md)
+* [Introduction](README.md)
+
+## Cronus Framework
+
+* [Domain Modeling](cronus-framework/domain-modeling.md)
+* [Workflows](cronus-framework/workflows.md)
+* [Event Store](cronus-framework/event-store.md)
+* [Messaging](cronus-framework/messaging.md)
+* [Configuration](cronus-framework/configuration.md)
+
+## Message Types
+
+* [Commands](message-types/commands.md)
+* [Events](message-types/events.md)
+* [Signals](message-types/signals.md)
+
+## Message Handlers
+
+* [Application Services](message-handlers/application-services.md)
+* [Projections](message-handlers/projections.md)
+* [Sagas](message-handlers/sagas.md)
+* [Ports](message-handlers/ports.md)
+* [Gateways](message-handlers/gateways.md)
+* [Triggers](message-handlers/triggers.md)
 
diff --git a/docs/configuration.md → docs/cronus-framework/configuration.md b/docs/configuration.md → docs/cronus-framework/configuration.md
diff --git a/docs/cronus-framework/domain-modeling.md b/docs/cronus-framework/domain-modeling.md
@@ -0,0 +1,2 @@
+# Domain Modeling
+
diff --git a/docs/cronus-framework/event-store.md b/docs/cronus-framework/event-store.md
@@ -0,0 +1,2 @@
+# Event Store
+
diff --git a/docs/cronus-framework/messaging.md b/docs/cronus-framework/messaging.md
@@ -0,0 +1,2 @@
+# Messaging
+
diff --git a/docs/cronus-framework/workflows.md b/docs/cronus-framework/workflows.md
@@ -0,0 +1,2 @@
+# Workflows
+
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/introduction.md b/docs/introduction.md
diff --git a/docs/message-handlers/application-services.md b/docs/message-handlers/application-services.md
@@ -0,0 +1,2 @@
+# Application Services
+
diff --git a/docs/message-handlers/gateways.md b/docs/message-handlers/gateways.md
@@ -0,0 +1,2 @@
+# Gateways
+
diff --git a/docs/message-handlers/ports.md b/docs/message-handlers/ports.md
@@ -0,0 +1,2 @@
+# Ports
+
diff --git a/docs/message-handlers/projections.md b/docs/message-handlers/projections.md
@@ -0,0 +1,2 @@
+# Projections
+
diff --git a/docs/message-handlers/sagas.md b/docs/message-handlers/sagas.md
@@ -0,0 +1,2 @@
+# Sagas
+
diff --git a/docs/message-handlers/triggers.md b/docs/message-handlers/triggers.md
@@ -0,0 +1,2 @@
+# Triggers
+
diff --git a/docs/message-types/commands.md b/docs/message-types/commands.md
@@ -0,0 +1,48 @@
+# Commands
+
+A command is used to dispatch domain model changes. It can be accepted or rejected depending on the domain model invariants.
+
+| Triggered by | Description |
+| :---: | :--- |
+| UI | It is NOT common practice to send commands directly from the UI. Usually the UI communicates with web APIs. |
+| API | APIs sit in the middle between UI and Server translating web requests into commands |
+| External System | It is NOT common practice to send commands directly from the External System. Usually the External System communicates with web APIs. |
+| Port | Ports are a simple way for an aggregate root to communicate with another aggregate root. |
+| Saga | Sagas are a simple way for an aggregate root to do complex communication with other aggregate roots. |
+
+{% hint style="success" %}
+**You can/should/must...**
+
+* a command must be immutable
+* a command must clearly state a business intent with a name in imperative form
+* a command can be rejected due to domain validation, error or other reason
+* a command must update only one AggregateRoot
+{% endhint %}
+
+```csharp
+public class DeactivateAccount : ICommand
+{
+    DeactivateAccount() {}
+    public DeactivateAccount(AccountId id, Reason reason)
+    {
+        Id = id;
+        Reason = reason;
+    }
+
+    public AccountId Id { get; private set; }
+    public Reason ReasonToDeactivate { get; private set; }
+}
+
+[DataContract(Name = "24c59143-b95e-4fd6-8bbf-8d5efffe3185")]
+public class AccountId : StringTenantId
+{
+    protected AccountId() { }
+    public AccountId(string id, string tenant) : base(id, "account", tenant) { }
+    public AccountId(IUrn urn) : base(urn, "account") { }
+}
+
+public class Reason : ValueObject<Reason>{...}
+```
+
+
+
diff --git a/docs/message-types/events.md b/docs/message-types/events.md
@@ -0,0 +1,2 @@
+# Events
+
diff --git a/docs/message-types/signals.md b/docs/message-types/signals.md
@@ -0,0 +1,2 @@
+# Signals
+
diff --git a/docs/test.md b/docs/test.md