Skip to content

Commit 25fa907

Browse files
committed
docs: minor updates
1 parent 10a9d67 commit 25fa907

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

docs/overview/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "Overview",
2+
"label": "Get started",
33
"position": 2,
44
"link": {
55
"type": "doc",

docs/overview/core-concepts.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 30
44

55
# Core concepts
66

7-
### ChangeUnits
7+
## ChangeUnits
88
**ChangeUnits** are the fundamental building blocks of Flamingock's Change-as-Code architecture. They represent atomic, versioned changes applied to target systems with complete safety guarantees and audit capabilities.
99

1010
Each ChangeUnit includes:
@@ -21,7 +21,7 @@ ChangeUnits can be implemented in two forms:
2121
For a deeper dive around ChangeUnits, see the [ChangeUnits](../change-units/anatomy-and-structure.md) section.
2222

2323

24-
### Templates
24+
## Templates
2525
Templates provide a reusable layer on top of ChangeUnits for common change patterns. When you have multiple changes that share similar logic (for example, executing SQL statements), templates allow you to abstract that common logic and reuse it.
2626

2727
With templates, you create multiple ChangeUnits using a declarative, low-code approach. Each ChangeUnit uses a template and passes its specific configuration. For example, an SQL template receives the SQL statement as configuration, executes it, and handles errors consistently.
@@ -49,6 +49,9 @@ For detailed configuration and implementation, see the [Recovery strategies](../
4949

5050
## Audit store
5151
The **audit store** is where Flamingock records metadata about change executions. Its purpose is to track which ChangeUnits have been executed, when they ran, and their outcomes. This ensures idempotency, enables rollbacks, and provides audit capabilities. The audit store is managed entirely by Flamingock - your code never directly interacts with it.
52+
:::info
53+
In Cloud Edition, the audit store is automatically provided - no configuration needed in your builder. Community Edition users must configure their own audit store.
54+
:::
5255

5356
## Target system
5457
The **target system** is where your actual business changes are applied. These are the systems your ChangeUnits modify - databases, message queues, APIs, configuration services, etc. Each ChangeUnit declares which target system it operates on.
@@ -78,9 +81,3 @@ Key characteristics:
7881
- Each stage defines where to find its changes (package or directory location)
7982

8083
For detailed information about stages and advanced configurations, see the [Setup and stages](../flamingock-library-config/setup-and-stages.md) section.
81-
82-
83-
## Events
84-
Flamingock can notify your application about the execution status of changes through events. This enables integration with monitoring systems, custom logging, or triggering downstream processes based on change completion.
85-
86-
For more information about events, see the [Events](../flamingock-library-config/events.md) section.

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const sidebars = {
2525
// Core Documentation Group
2626
{
2727
type: 'html',
28-
value: '<div class="sidebar-contents-header">Overview</div>',
28+
value: '<div class="sidebar-contents-header">Get started</div>',
2929
},
3030
{
3131
type: 'autogenerated',

0 commit comments

Comments
 (0)