Skip to content

Commit 37d66d1

Browse files
authored
Removed use case coming soons that are slated further in the future (#873)
1 parent 959b010 commit 37d66d1

File tree

10 files changed

+20
-74
lines changed

10 files changed

+20
-74
lines changed

docs/.vuepress/configs/sidebar.ts

+1-15
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,7 @@ export const sidebarEn: EsSidebarOptions = {
5050
]
5151
}
5252
]
53-
},
54-
"/getting-started/use-cases/outbox-out-of-the-box.md",
55-
"/getting-started/use-cases/microservices.md",
56-
"/getting-started/use-cases/time-traveling.md",
57-
"/getting-started/use-cases/business-workflow.md",
58-
]
59-
},
60-
{
61-
text: "Best Practices",
62-
collapsible: true,
63-
expanded: false,
64-
group: "Best Practices",
65-
children: [
66-
"/getting-started/best-practices/checkpoint.md",
67-
"/getting-started/best-practices/exactly-once-processing.md"
53+
}
6854
]
6955
},
7056
{

docs/getting-started/best-practices/checkpoint.md

-5
This file was deleted.

docs/getting-started/best-practices/exactly-once-processing.md

-5
This file was deleted.

docs/getting-started/use-cases/business-workflow.md

-5
This file was deleted.

docs/getting-started/use-cases/microservices.md

-5
This file was deleted.

docs/getting-started/use-cases/mix-and-match-database/tutorial-2.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,6 @@ You will examine how this pattern is applied to the Postgres projection applicat
140140
::: info Understanding Checkpoint
141141
A projection often uses a checkpoint to recover the position of the last processed event. This way, when an application unexpectedly crashes mid-process, the projection does not have to process all the previously processed events.
142142

143-
For more information about checkpoints, [click here](../../best-practices/checkpoint.md)
144-
145143
:::
146144

147145
::: info Storing Checkpoints in Relational Databases
@@ -217,20 +215,17 @@ You will examine how this pattern is applied to the Postgres projection applicat
217215

218216
::: info Exactly-once processing
219217
This implementation ensures exactly-once processing by using KurrentDB for reliable persistence, idempotent projection logic, and transactional updates. The read model and checkpoint are updated atomically, preventing duplicates or inconsistencies, unlike traditional message brokers that rely on at-least-once or at-most-once delivery.
220-
221-
For more information about exactly-once processing with catch-up subscription and transactional checkpoints, [click here](../../best-practices/exactly-once-processing.md)
222-
223218
:::
224219

225220
The `CartProjection.Project(e)` function above returns a SQL command that updates the read model depending on the event.
226221

227-
4. Run the following command in the terminal to open the code that performs for the Postgres projection:
222+
5. Run the following command in the terminal to open the code that performs for the Postgres projection:
228223

229224
```sql
230225
code ./PostgresProjection/CartProjection.cs
231226
```
232227

233-
5. Locate and examine the code that handles the projection for the `CustomerStartedShopping` event:
228+
6. Locate and examine the code that handles the projection for the `CustomerStartedShopping` event:
234229

235230
```cs
236231
private static IEnumerable<CommandDefinition>? Project(CustomerStartedShopping evt)
@@ -247,7 +242,7 @@ You will examine how this pattern is applied to the Postgres projection applicat
247242

248243
This returns a sql command that inserts a cart if `CustomerStartedShopping` event is received.
249244

250-
6. Locate and examine the code that handles the projection for the `CartGotCheckedOut` event:
245+
7. Locate and examine the code that handles the projection for the `CartGotCheckedOut` event:
251246

252247
```cs
253248
private static IEnumerable<CommandDefinition>? Project(CartGotCheckedOut evt)

docs/getting-started/use-cases/mix-and-match-database/tutorial-intro.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,19 @@ Before starting, ensure you have the following:
2626

2727
This tutorial consists of the following steps:
2828

29-
### [Part 1: Setup and Initialize KurrentDB](./tutorial-1.md)
30-
1. **[Set up your Codespaces](./tutorial-1.html#step-1-set-up-your-codespaces)**: Starts up an interactive coding environment in your browser where all tools and database are installed
31-
2. **[Start and Initialize KurrentDB with Sample Events](./tutorial-1.html#step-2-start-and-initialize-kurrentdb-with-sample-events)**: Start up KurrentDB and initialize it with sample events
32-
3. **[Browse the Sample Events in KurrentDB's Admin UI](./tutorial-1.html#step-3-browse-sample-events-in-kurrentdb-s-admin-ui)**: Access the Admin UI to browse the appended events
33-
### [Part 2: Project KurrentDB Events to Postgres](./tutorial-2.md)
34-
4. **[Execute Projection Applications](./tutorial-2.html#step-4-execute-projection-application)**: Starts up the projection sample applications that transform KurrentDB events into read models in Postgres and Redis
35-
5. **[Review the Projected Read Models in Postgres](./tutorial-2.html#step-5-review-the-projected-read-models-in-postgres)**: Run the PostgreSQL command line tool to review the newly inserted records
36-
6. **[Examine the Postgres Projection Application Codebase](./tutorial-2.html#step-6-examine-the-postgres-projection-application-codebase)**: Examine the PostgreSQL projection application codebase to see how events are transformed to read models in the tables
37-
### [Part 3: Project KurrentDB Events to Redis](./tutorial-3.md)
38-
7. **[Review the Projected Read Models in Redis](./tutorial-3.html#step-7-review-the-projected-read-models-in-redis)**: Run the Redis command line tool to review the newly added entries
39-
8. **[Examine the Redis Projection Application Codebase](./tutorial-3.html#step-8-examine-the-redis-projection-application-codebase)**: Examine the Redis projection application codebase to see how events are transformed into read models in Redis
40-
### [Part 4: Project KurrentDB Events in Real-Time](./tutorial-4.md)
41-
9. **[Browse the Demo Web Page](./tutorial-4.html#step-9-browse-the-demo-web-page)**: Navigate to the Demo Web Page to see a sample of how the read models in Postgres and Redis are used
42-
10. **[Start the Live Data Generator](./tutorial-4.html#step-10-start-the-live-data-generator)**: Start a live data generator program that continuously appends events into KurrentDB
43-
11. **[Watch the Read Models Update in Real-Time](./tutorial-4.html#step-11-watch-the-read-models-update-in-real-time)**: See how the read models are updated in real-time in the Demo Web Page
44-
12. **[Understanding catch-up subscription and real-time processing](./tutorial-4.html#step-12-understanding-catch-up-subscription-and-real-time-processing)**: Understand how the code projects events to the read models in real-time
29+
### [Part 1: Setup and Initialize KurrentDB](/getting-started/use-cases/mix-and-match-database/tutorial-1.md)
30+
1. **[Set up your Codespaces](/getting-started/use-cases/mix-and-match-database/tutorial-1.md#step-1-set-up-your-codespaces)**: Starts up an interactive coding environment in your browser where all tools and database are installed
31+
2. **[Start and Initialize KurrentDB with Sample Events](/getting-started/use-cases/mix-and-match-database/tutorial-1.md#step-2-start-and-initialize-kurrentdb-with-sample-events)**: Start up KurrentDB and initialize it with sample events
32+
3. **[Browse the Sample Events in KurrentDB's Admin UI](/getting-started/use-cases/mix-and-match-database/tutorial-1.md#step-3-browse-sample-events-in-kurrentdb-s-admin-ui)**: Access the Admin UI to browse the appended events
33+
### [Part 2: Project KurrentDB Events to Postgres](/getting-started/use-cases/mix-and-match-database/tutorial-2.md)
34+
4. **[Execute Projection Applications](/getting-started/use-cases/mix-and-match-database/tutorial-2.md#step-4-execute-projection-application)**: Starts up the projection sample applications that transform KurrentDB events into read models in Postgres and Redis
35+
5. **[Review the Projected Read Models in Postgres](/getting-started/use-cases/mix-and-match-database/tutorial-2.md#step-5-review-the-projected-read-models-in-postgres)**: Run the PostgreSQL command line tool to review the newly inserted records
36+
6. **[Examine the Postgres Projection Application Codebase](/getting-started/use-cases/mix-and-match-database/tutorial-2.md#step-6-examine-the-postgres-projection-application-codebase)**: Examine the PostgreSQL projection application codebase to see how events are transformed to read models in the tables
37+
### [Part 3: Project KurrentDB Events to Redis](/getting-started/use-cases/mix-and-match-database/tutorial-3.md)
38+
7. **[Review the Projected Read Models in Redis](/getting-started/use-cases/mix-and-match-database/tutorial-3.md#step-7-review-the-projected-read-models-in-redis)**: Run the Redis command line tool to review the newly added entries
39+
8. **[Examine the Redis Projection Application Codebase](/getting-started/use-cases/mix-and-match-database/tutorial-3.md#step-8-examine-the-redis-projection-application-codebase)**: Examine the Redis projection application codebase to see how events are transformed into read models in Redis
40+
### [Part 4: Project KurrentDB Events in Real-Time](/getting-started/use-cases/mix-and-match-database/tutorial-4.md)
41+
9. **[Browse the Demo Web Page](/getting-started/use-cases/mix-and-match-database/tutorial-4.md#step-9-browse-the-demo-web-page)**: Navigate to the Demo Web Page to see a sample of how the read models in Postgres and Redis are used
42+
10. **[Start the Live Data Generator](/getting-started/use-cases/mix-and-match-database/tutorial-4.md#step-10-start-the-live-data-generator)**: Start a live data generator program that continuously appends events into KurrentDB
43+
11. **[Watch the Read Models Update in Real-Time](/getting-started/use-cases/mix-and-match-database/tutorial-4.md#step-11-watch-the-read-models-update-in-real-time)**: See how the read models are updated in real-time in the Demo Web Page
44+
12. **[Understanding catch-up subscription and real-time processing](/getting-started/use-cases/mix-and-match-database/tutorial-4.md#step-12-understanding-catch-up-subscription-and-real-time-processing)**: Understand how the code projects events to the read models in real-time

docs/getting-started/use-cases/operational-audit-log.md

-5
This file was deleted.

docs/getting-started/use-cases/outbox-out-of-the-box.md

-5
This file was deleted.

docs/getting-started/use-cases/time-traveling.md

-5
This file was deleted.

0 commit comments

Comments
 (0)