Updated docs (#244)

* Updated getting-started * Updated name of packages * Updated docs structure * Updated docs
adimiko · Jun 4, 2024 · 56efe4f · 56efe4f
1 parent 79d7cd6
commit 56efe4f
Show file tree

Hide file tree

Showing 16 changed files with 79 additions and 149 deletions.
diff --git a/documentation/docs/getting-started.md b/documentation/docs/getting-started.md
@@ -10,8 +10,7 @@ Example shows in-memory implementation.
 ## Configuration
 ### Install packages
 ```csharp
-dotnet add package TransactionalBox.Outbox
-dotnet add package TransactionalBox.Inbox
+dotnet add package TransactionalBox
 ```
 ### Register
 ```csharp

diff --git a/documentation/docs/inbox/general.md → documentation/docs/inbox.md b/documentation/docs/inbox/general.md → documentation/docs/inbox.md
@@ -1,8 +1,8 @@
 ---
-sidebar_position: 1
+sidebar_position: 4
 ---
 
-# General
+# Inbox
 
 The inbox is responsible for getting messages from the transport and adding them to the storage, and then processes these messages.
 

diff --git a/documentation/docs/inbox/_category_.json b/documentation/docs/inbox/_category_.json
diff --git a/documentation/docs/inbox/storage/_category_.json b/documentation/docs/inbox/storage/_category_.json
diff --git a/documentation/docs/inbox/storage/entity-framework-core.md b/documentation/docs/inbox/storage/entity-framework-core.md
diff --git a/documentation/docs/inbox/storage/in-memory.md b/documentation/docs/inbox/storage/in-memory.md
diff --git a/documentation/docs/inbox/transport/_category_.json b/documentation/docs/inbox/transport/_category_.json
diff --git a/documentation/docs/inbox/transport/kafka.md b/documentation/docs/inbox/transport/kafka.md
diff --git a/documentation/docs/outbox/general.md → documentation/docs/outbox.md b/documentation/docs/outbox/general.md → documentation/docs/outbox.md
@@ -1,8 +1,8 @@
 ---
-sidebar_position: 1
+sidebar_position: 3
 ---
 
-# General
+# Outbox
 
 The outbox is responsible for adding messages to the storage  and then adding at least once to the transport.
 

diff --git a/documentation/docs/outbox/_category_.json b/documentation/docs/outbox/_category_.json
diff --git a/documentation/docs/outbox/transport/kafka.md b/documentation/docs/outbox/transport/kafka.md
diff --git a/...ation/docs/outbox/storage/_category_.json → documentation/docs/storage/_category_.json b/...ation/docs/outbox/storage/_category_.json → documentation/docs/storage/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Storage",
-  "position": 2
+  "position": 5
 }
diff --git a/...s/outbox/storage/entity-framework-core.md → ...ion/docs/storage/entity-framework-core.md b/...s/outbox/storage/entity-framework-core.md → ...ion/docs/storage/entity-framework-core.md
@@ -23,14 +23,12 @@ builder.Services.AddDbContextPool<SampleDbContext>(x => x.Use...(connectionStrin
 ```
 :::
 
-
-
-## Configuration
-### Install package
+## Install package
 ```csharp
-dotnet add package TransactionalBox.Outbox.EntityFrameworkCore
+dotnet add package TransactionalBox.EntityFrameworkCore
 ```
 
+## Outbox
 ### Register entity framework as outbox storage
 ```csharp
 builder.Services.AddTransactionalBox(x =>
@@ -51,4 +49,27 @@ public class SampleDbContext : DbContext
     }
     ...
 }
+```
+
+## Inbox
+### Register entity framework as inbox storage
+```csharp
+builder.Services.AddTransactionalBox(x =>
+{
+    x.AddInbox(storage => storage.UseEntityFramework<SampleDbContext>());
+});
+
+```
+
+### Add Inbox to ModelBuilder
+```csharp
+public class SampleDbContext : DbContext
+{
+    ...
+    protected override void OnModelCreating(ModelBuilder modelBuilder)
+    {
+        modelBuilder.AddInbox();
+    }
+    ...
+}
 ```
diff --git a/...entation/docs/outbox/storage/in-memory.md → documentation/docs/storage/in-memory.md b/...entation/docs/outbox/storage/in-memory.md → documentation/docs/storage/in-memory.md
@@ -10,11 +10,22 @@ InMemory is registered as default storage.
 Intended only for testing and learning.
 :::
 
+## Outbox
 ### Register
 ```csharp
 builder.Services.AddTransactionalBox(x =>
 {
     x.AddOutbox();
 });
 
+```
+
+## Inbox
+### Register
+```csharp
+builder.Services.AddTransactionalBox(x =>
+{
+    x.AddInbox();
+});
+
 ```
diff --git a/...ion/docs/outbox/transport/_category_.json → documentation/docs/transport/_category_.json b/...ion/docs/outbox/transport/_category_.json → documentation/docs/transport/_category_.json
@@ -1,4 +1,4 @@
 {
   "label": "Transport",
-  "position": 2
+  "position": 6
 }
diff --git a/documentation/docs/transport/kafka.md b/documentation/docs/transport/kafka.md
@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+---
+
+# Apache Kafka
+
+## Install package
+```csharp
+dotnet add package TransactionalBox.Kafka
+```
+## Outbox
+### Register
+```csharp
+builder.Services.AddTransactionalBox(x =>
+{
+    x.AddOutbox(
+        storage => ...,
+        transport => transport.UseKafka(settings => settings.BootstrapServers = bootstrapServers)
+    );
+});
+
+```
+
+## Inbox
+### Register
+```csharp
+builder.Services.AddTransactionalBox(x =>
+{
+    x.AddInbox(
+        storage => ...,
+        transport => transport.UseKafka(settings => settings.BootstrapServers = bootstrapServers)
+    );
+});
+
+```