Skip to content

Commit 533c5aa

Browse files
Deflaimuncoloradomorrisseyhayley-jean
authored
docs: Rebrand from EventStore to Kurrent (#828)
Co-authored-by: Mark Morrissey <[email protected]> Co-authored-by: Hayley Campbell <[email protected]>
1 parent 823fb8e commit 533c5aa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+499
-493
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @EventStore/documentation
1+
* @kurrent-io/documentation

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Contributing to Event Store Documentation
1+
# Contributing to Kurrent Documentation
22

33
## Working with the Git
44

5-
Event Store Documentation uses `master` as the main development branch. All the changes merged to this branch are deployed live.
5+
Kurrent Documentation uses `master` as the main development branch. All the changes merged to this branch are deployed live.
66

77
We do our best to ensure a clean history. To do so, we ask contributors to squash their commits into a set or single logical commit. Alternatively, those who merge the PRs will use the Squash and Merge feature of GitHub.
88

@@ -37,7 +37,7 @@ The local build must complete successfully before you open a pull request.
3737

3838
## Importing documentation
3939

40-
This repository contains documentation about Event Store and its client SDKs. The documentation for EventStoreDB, including its HTTP API, is imported from the respective repositories on build. To import the documentation manually, run:
40+
This repository contains documentation about Kurrent and its client SDKs. The documentation for KurrentDB, including its HTTP API, is imported from the respective repositories on build. To import the documentation manually, run:
4141

4242
```bash
4343
pnpm run import
@@ -55,9 +55,9 @@ The documentation sources are located in the `/docs` directory. The `/docs/.vuep
5555

5656
Other directors inside `/docs` include:
5757
- `clients`: documentation for current and legacy clients
58-
- `cloud`: Event Store Cloud documentation
59-
- `server`: EventStoreDB documentation imported from the server repository
60-
- `http-api`: EventStoreDB HTTP API documentation imported from the server repository
58+
- `cloud`: Kurrent Cloud documentation
59+
- `server`: KurrentDB documentation imported from the server repository
60+
- `http-api`: KurrentDB HTTP API documentation imported from the server repository
6161
- `samples`: imported code samples for the client SDKs, server, and HTTP API
6262

6363
Directories with imported code like `server`, `http-api`, and `samples` are generated on build and should not be edited manually. They are also listed in `.gitignore` and won't be committed to the repository.

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
# EventStoreDB documentation
1+
# KurrentDB documentation
22

3-
EventStoreDB is an open-source, functional database with Complex Event Processing in JavaScript.
3+
KurrentDB (formerly EventStoreDB) is the leading event-native data platform, enabling organizations to build modern, event-driven applications and unlock the power of their business history. By capturing every change as an immutable event, KurrentDB provides a single source of truth for real-time data, historical analysis, and advanced AI/ML initiatives.
44

5-
This repository maintains documentation for EventStoreDB (imported from the server repository on build), Event Store Cloud, client SDKs, and other tools and product provided by Event Store.
5+
This repository maintains documentation for KurrentDB (imported from the server repository on build), Kurrent Cloud, client SDKs, and other tools and product provided by Kurrent.
66

77
## Contributing
88

9-
Feel free to [create a GitHub](https://github.com/EventStore/documentation/issues/new) issue if you have any questions or request for more explanation or samples.
9+
Feel free to [create a GitHub](https://github.com/kurrent-io/documentation/issues/new) issue if you have any questions or request for more explanation or samples.
1010

11-
We're open to any contribution. If you noticed some inconsistency, missing piece, or you'd like to extend existing docs - we'll be happy to [get your Pull Request](https://github.com/EventStore/documentation/compare).
11+
We're open to any contribution. If you noticed some inconsistency, missing piece, or you'd like to extend existing docs - we'll be happy to [get your Pull Request](https://github.com/kurrent-io/documentation/compare).
1212

13-
Note that EventStoreDB documentation is located in the [server repository](https://github.com/EventStore/EventStore). Open issues and PRs for server documentation in there.
13+
Note that KurrentDB documentation is located in the [server repository](https://github.com/kurrent-io/KurrentDB). Open issues and PRs for server documentation in there.
1414

1515
Please make sure to follow the [contribution guidelines](CONTRIBUTING.md). It contains detailed information on how to contribute to the documentation.
1616

1717
## Samples
1818

19-
EventStoreDB clients:
20-
- C# - [see more](https://github.com/EventStore/EventStore-Client-Dotnet/tree/master/samples)
21-
- NodeJS - [see more](https://github.com/EventStore/EventStore-Client-NodeJS/tree/master/packages/test/src/samples)
22-
- Java - [see more](https://github.com/EventStore/EventStoreDB-Client-Java/tree/trunk/src/test/java/io/kurrent/dbclient/samples)
23-
- Rust - [see more](https://github.com/EventStore/EventStoreDB-Client-Rust/tree/master/examples)
24-
- Go - [see more](https://github.com/EventStore/EventStore-Client-Go/tree/master/samples)
19+
KurrentDB clients:
20+
- C# - [see more](https://github.com/kurrent-io/EventStore-Client-Dotnet/tree/master/samples)
21+
- NodeJS - [see more](https://github.com/kurrent-io/KurrentDB-Client-NodeJS/tree/master/packages/test/src/samples)
22+
- Java - [see more](https://github.com/kurrent-io/KurrentDB-Client-Java/tree/trunk/src/test/java/io/kurrent/dbclient/samples)
23+
- Rust - [see more](https://github.com/kurrent-io/KurrentDB-Client-Rust/tree/master/examples)
24+
- Go - [see more](https://github.com/kurrent-io/KurrentDB-Client-Go/tree/master/samples)
2525

2626
## Local development
2727

docs/.vuepress/components/xode/store.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import {reactive} from "vue";
22
import {getUrlParamValue} from "../../lib/url";
33
import {getStorageValue, setStorageValue} from "../../lib/localStorage";
44

5-
const prefix = "eventstore-docs";
5+
const prefix = "kurrent-docs";
66
const langStorageName = "codeLanguage";
77

88
function getSelectedCodeLanguage() {

docs/.vuepress/configs/navbar.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import {instance as ver} from "../lib/versioning";
21
import type {NavbarOptions} from "vuepress-theme-hope";
2+
import {instance as ver} from "../lib/versioning";
33

44
export const navbarEn: NavbarOptions = [
55
{
@@ -25,7 +25,7 @@ export const navbarEn: NavbarOptions = [
2525
text: "Clients & APIs",
2626
icon: "material-symbols:sdk",
2727
children: [
28-
{text: "Clients", children: [{text: "EventStoreDB clients", link: "/clients/grpc/getting-started"}]},
28+
{text: "Clients", children: [{text: "KurrentDB clients", link: "/clients/grpc/getting-started"}]},
2929
{text: "HTTP API", children: ver.linksFor("http-api", false)},
3030
{text: "Deprecated", children: [{text: "Legacy TCP clients", link: "/clients/tcp/"}]},
3131
]

docs/.vuepress/configs/plugins/notices.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export const notices: NoticePluginOptions = {
1111
{
1212
path: "/clients/tcp/dotnet/21.2/",
1313
title: "This documentation is for the legacy TCP client",
14-
content: "This client is no longer supported because newer versions of EventStoreDB only support gRPC-based client protocol. Please use the latest client libraries.",
14+
content: "This client is no longer supported because newer versions of KurrentDB only support gRPC-based client protocol. Please use the latest client libraries.",
1515
actions: [
1616
{
1717
text: "Migration guide",

docs/.vuepress/lib/samples.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ export function resolveSamplesPath(src: string, srcCat: string | undefined) {
5252
},
5353
"go": {
5454
label: "Go",
55-
path: "clients/go/4.2.0"
55+
path: "clients/go/1.0.0"
5656
},
5757
"rs": {
5858
label: "Rust",
@@ -92,4 +92,4 @@ export function resolveSamplesPath(src: string, srcCat: string | undefined) {
9292
return {label: lang.label, path: path.resolve(__dirname, p)};
9393
}
9494

95-
export const projectionSamplesPath = "https://raw.githubusercontent.com/EventStore/EventStore/53f84e55ea56ccfb981aff0e432581d72c23fbf6/samples/http-api/data/";
95+
export const projectionSamplesPath = "https://raw.githubusercontent.com/kurrent-io/KurrentDB/53f84e55ea56ccfb981aff0e432581d72c23fbf6/samples/http-api/data/";

docs/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ highlights:
1919
icon: hugeicons:cloud
2020
link: https://www.kurrent.io/kurrent-cloud
2121
- title: Start KurrentDB in a container
22-
details: Run <code>docker run eventstore/eventstore:latest --dev</code> to start EventStoreDB in developers mode.
22+
details: Run <code>docker run kurrentplatform/kurrentdb:latest --dev</code> to start KurrentDB in developers mode.
2323
icon: simple-icons:docker
2424
link: /latest/quick-start/installation.html#docker
2525
- title: Start using the client
@@ -28,7 +28,7 @@ highlights:
2828
link: /clients/grpc/getting-started.html
2929

3030
- header: Deploy in your environment
31-
description: Deploy EventStoreDB in your environment using our binaries, Docker Compose, or Kubernetes Operator.
31+
description: Deploy KurrentDB in your environment using our binaries, Docker Compose, or Kubernetes Operator.
3232
features:
3333
- title: AWS
3434
icon: skill-icons:aws-dark
@@ -47,17 +47,17 @@ highlights:
4747

4848
- title: Linux
4949
icon: devicon:linux
50-
details: Use Event Store package feeds for Ubuntu, Debian, CentOS, and Red Hat Enterprise Linux.
50+
details: Use Kurrent package feeds for Ubuntu, Debian, CentOS, and Red Hat Enterprise Linux.
5151
link: /latest/quick-start/installation.html#install-from-packagecloud
5252

5353
- title: Windows
5454
icon: devicon:windows8
55-
details: Download the Windows binaries or use Chocolatey to install EventStoreDB.
55+
details: Download the Windows binaries or use Chocolatey to install KurrentDB.
5656
link: /latest/quick-start/installation.html#windows
5757

5858
- title: Docker
5959
icon: logos:docker-icon
60-
details: Use Docker Compose to pull images from Docker Hub and run EventStoreDB in containers.
60+
details: Use Docker Compose to pull images from Cloudsmith and run KurrentDB in containers.
6161
link: /latest/quick-start/installation.html#use-docker-compose
6262

6363
- header: Develop in your language
@@ -75,27 +75,27 @@ highlights:
7575

7676
- title: C#
7777
icon: devicon:csharp
78-
details: Build .NET applications with EventStoreDB using the .NET client for latest .NET and legacy .NET Framework.
78+
details: Build .NET applications with KurrentDB using the .NET client for latest .NET and legacy .NET Framework.
7979
link: /client/csharp
8080

8181
- title: Python
8282
icon: devicon:python
83-
details: Create applications and scripts in Python using the EventStoreDB client.
83+
details: Create applications and scripts in Python using the KurrentDB client.
8484
link: /client/Python
8585

8686
- title: Rust
8787
icon: skill-icons:rust
88-
details: Bring EventStoreDB to your Rust applications using the Rust client.
88+
details: Bring KurrentDB to your Rust applications using the Rust client.
8989
link: /client/Rust
9090

9191
- title: Go
9292
icon: skill-icons:golang
93-
details: Connect EventStoreDB with your Go applications using the Go client.
93+
details: Connect KurrentDB with your Go applications using the Go client.
9494
link: /client/Go
9595

9696
- title: HTTP API
9797
icon: catppuccin:http
98-
details: Use EventStoreDB's HTTP API to interact with the database using any language or stack.
98+
details: Use KurrentDB's HTTP API to interact with the database using any language or stack.
9999
link: https://docs.kurrent.io/http-api/v24.10/introduction.html
100100

101101
footer: Copyright © 2025 Kurrent, Inc

docs/clients/grpc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@ breadcrumbExclude: true
55

66
# Clients
77

8-
Learn how to use the EventStoreDB client libraries to interact with the database.
8+
Learn how to use the KurrentDB client libraries to interact with the database.
99

1010
<Catalog/>

docs/clients/grpc/appending-events.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ order: 2
44

55
# Appending events
66

7-
When you start working with EventStoreDB, it is empty. The first meaningful operation is to add one or more events to the database using one of the available client SDKs.
7+
When you start working with KurrentDB, it is empty. The first meaningful operation is to add one or more events to the database using one of the available client SDKs.
88

99
::: tip
1010
Check the [Getting Started](getting-started.md) guide to learn how to configure and use the client SDK.
1111
:::
1212

1313
## Append your first event
1414

15-
The simplest way to append an event to EventStoreDB is to create an `EventData` object and call `AppendToStream` method.
15+
The simplest way to append an event to KurrentDB is to create an `EventData` object and call `AppendToStream` method.
1616

1717
@[code{append-to-stream}](@grpc:appending_events.py;appending-events.js;appending-events.ts;appending_events/AppendingEvents.java;appending-events/Program.cs;appendingEvents.go;appending_events.rs)
1818

@@ -26,11 +26,11 @@ If you are new to Event Sourcing, please study the [Handling concurrency](#handl
2626

2727
## Working with EventData
2828

29-
Events appended to EventStoreDB must be wrapped in an `EventData` object. This allows you to specify the event's content, the type of event, and whether it's in JSON format. In its simplest form, you need three arguments: **eventId**, **type**, and **data**.
29+
Events appended to KurrentDB must be wrapped in an `EventData` object. This allows you to specify the event's content, the type of event, and whether it's in JSON format. In its simplest form, you need three arguments: **eventId**, **type**, and **data**.
3030

3131
### eventId
3232

33-
This takes the format of a `Uuid` and is used to uniquely identify the event you are trying to append. If two events with the same `Uuid` are appended to the same stream in quick succession, EventStoreDB will only append one of the events to the stream.
33+
This takes the format of a `Uuid` and is used to uniquely identify the event you are trying to append. If two events with the same `Uuid` are appended to the same stream in quick succession, KurrentDB will only append one of the events to the stream.
3434

3535
For example, the following code will only append a single event:
3636

@@ -46,19 +46,19 @@ It is common to see the explicit event code type name used as the type as it mak
4646

4747
### data
4848

49-
Representation of your event data. It is recommended that you store your events as JSON objects. This allows you to take advantage of all of EventStoreDB's functionality, such as projections. That said, you can save events using whatever format suits your workflow. Eventually, the data will be stored as encoded bytes.
49+
Representation of your event data. It is recommended that you store your events as JSON objects. This allows you to take advantage of all of KurrentDB's functionality, such as projections. That said, you can save events using whatever format suits your workflow. Eventually, the data will be stored as encoded bytes.
5050

5151
### metadata
5252

53-
Storing additional information alongside your event that is part of the event itself is standard practice. This can be correlation IDs, timestamps, access information, etc. EventStoreDB allows you to store a separate byte array containing this information to keep it separate.
53+
Storing additional information alongside your event that is part of the event itself is standard practice. This can be correlation IDs, timestamps, access information, etc. KurrentDB allows you to store a separate byte array containing this information to keep it separate.
5454

5555
### isJson
5656

57-
Simple boolean field to tell EventStoreDB if the event is stored as json, true by default.
57+
Simple boolean field to tell KurrentDB if the event is stored as json, true by default.
5858

5959
## Handling concurrency
6060

61-
When appending events to a stream, you can supply a *stream state* or *stream revision*. Your client uses this to inform EventStoreDB of the state or version you expect the stream to be in when appending an event. If the stream isn't in that state, an exception will be thrown.
61+
When appending events to a stream, you can supply a *stream state* or *stream revision*. Your client uses this to inform KurrentDB of the state or version you expect the stream to be in when appending an event. If the stream isn't in that state, an exception will be thrown.
6262

6363
For example, if you try to append the same record twice, expecting both times that the stream doesn't exist, you will get an exception on the second:
6464

@@ -69,7 +69,7 @@ There are three available stream states:
6969
- `NoStream`
7070
- `StreamExists`
7171

72-
This check can be used to implement optimistic concurrency. When retrieving a stream from EventStoreDB, note the current version number. When you save it back, you can determine if somebody else has modified the record in the meantime.
72+
This check can be used to implement optimistic concurrency. When retrieving a stream from KurrentDB, note the current version number. When you save it back, you can determine if somebody else has modified the record in the meantime.
7373

7474
@[code{append-with-concurrency-check}](@grpc:appending_events.py;appending-events.js;appending-events.ts;appending_events/AppendingEvents.java;appending-events/Program.cs;appendingEvents.go;appending_events.rs)
7575

0 commit comments

Comments
 (0)