Skip to content

Commit c0d3cf6

Browse files
authored
docs: general updates and fixed links (#80)
1 parent b72e5d0 commit c0d3cf6

21 files changed

Lines changed: 73 additions & 70 deletions

docs/audit-stores/community/couchbase-audit-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
This page explains how to configure **Couchbase** as Flamingock's audit store.
1212
The audit store is where Flamingock records execution history and ensures safe coordination across distributed deployments.
1313

14-
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../overview/audit-store-vs-target-system.md).
14+
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../../overview/audit-store-vs-target-system.md).
1515
1616

1717
## Minimum setup
@@ -157,5 +157,5 @@ Flamingock.builder()
157157

158158
## Next steps
159159

160-
- Learn about [Target systems](../flamingock-library-config/target-system-configuration.md)
160+
- Learn about [Target systems](../../target-systems/introduction.md)
161161
- 👉 See a [full example project](https://github.com/flamingock/flamingock-examples/tree/master/couchbase)

docs/audit-stores/community/dynamodb-audit-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
This page explains how to configure **Amazon DynamoDB** as Flamingock's audit store.
1212
The audit store is where Flamingock records execution history and ensures safe coordination across distributed deployments.
1313

14-
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../overview/audit-store-vs-target-system.md).
14+
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../../overview/audit-store-vs-target-system.md).
1515
1616

1717
## Minimum setup
@@ -161,5 +161,5 @@ Consider using **ON_DEMAND** billing mode for unpredictable workloads.
161161

162162
## Next steps
163163

164-
- Learn about [Target systems](../flamingock-library-config/target-system-configuration.md)
164+
- Learn about [Target systems](../../target-systems/introduction.md)
165165
- 👉 See a [full example project](https://github.com/flamingock/flamingock-examples/tree/master/dynamodb)

docs/audit-stores/community/mongodb-audit-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
This page explains how to configure **MongoDB** as Flamingock's audit store.
1212
The audit store is where Flamingock records execution history and ensures safe coordination across distributed deployments.
1313

14-
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../overview/audit-store-vs-target-system.md).
14+
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../../overview/audit-store-vs-target-system.md).
1515
1616

1717
## Minimum setup
@@ -179,5 +179,5 @@ Recommended only for dev/test environments.
179179

180180
## Next steps
181181

182-
- Learn about [Target systems](../targetsystems/configuration.md)
182+
- Learn about [Target systems](../../target-systems/introduction.md)
183183
- 👉 See a [full example project](https://github.com/flamingock/flamingock-examples/tree/master/mongodb)

docs/audit-stores/community/mongodb-springdata-audit-store.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import TabItem from '@theme/TabItem';
1111
This page explains how to configure **MongoDB with Spring Data** as Flamingock's audit store.
1212
The audit store is where Flamingock records execution history and ensures safe coordination across distributed deployments.
1313

14-
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../overview/audit-store-vs-target-system.md).
14+
> For a conceptual explanation of the audit store vs target systems, see [Audit store vs target system](../../overview/audit-store-vs-target-system.md).
1515
1616

1717
## Minimum setup
@@ -211,5 +211,5 @@ Spring Boot will automatically:
211211

212212
## Next steps
213213

214-
- Learn about [Target systems](../flamingock-library-config/target-system-configuration.md)
214+
- Learn about [Target systems](../../target-systems/introduction.md)
215215
- 👉 See a [full example project](https://github.com/flamingock/flamingock-examples/tree/master/mongodb-springdata)

docs/audit-stores/introduction.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,21 @@ Unlike target systems (which your code modifies), the audit store is managed aut
1818

1919
> **Conceptual overview**: For architectural understanding, see [Target systems vs audit store](../overview/audit-store-vs-target-system.md)
2020
21-
## Supported audit stores
21+
## Audit store options
2222

23-
Flamingock supports several databases as audit stores:
23+
### Cloud Edition
24+
The audit store is **automatically provided and managed** by Flamingock Cloud. No configuration needed - just focus on your changes while Flamingock handles the audit infrastructure.
25+
26+
### Community setup
27+
Alternatively, you can configure your own audit store using one of the supported databases:
2428

2529
- [MongoDB audit store](./community/mongodb-audit-store.md)
2630
- [MongoDB Spring Data audit store](./community/mongodb-springdata-audit-store.md)
27-
- [DynamoDB audit store](./community/dynamodb-audit-store.md)
31+
- [DynamoDB audit store](./community/dynamodb-audit-store.md)
2832
- [Couchbase audit store](./community/couchbase-audit-store.md)
2933

30-
### Configuration pattern
34+
35+
### Community configuration pattern
3136

3237
Register the audit store with the Flamingock builder:
3338

docs/change-units/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,4 +74,4 @@ Dive deeper into specific aspects of ChangeUnits:
7474
7575
Or continue to other key concepts:
7676
- **[Target Systems](../target-systems/introduction.md)** - Configure where your changes will be applied
77-
- **[Templates](../templates/introduction.md)** - Explore reusable change patterns
77+
- **[Templates](../templates/templates-introduction.md)** - Explore reusable change patterns

docs/frameworks/springboot-integration/builder-based-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ FlamingockBuilder builder = Flamingock
8787

8888
:::info
8989
Platform components are registered using the same `.addDependency(...)` method used for change unit dependencies.
90-
For details, see the [Platform component injection](../../flamingock-library-config/platform-component-injection.md) page.
90+
For details, see the [Context and dependencies](../../flamingock-library-config/context-and-dependencies.md) page.
9191
:::
9292
## Overriding Spring-provided dependencies
9393
When using the builder-based setup, Flamingock will attempt to resolve dependencies using the Spring context.

docs/frameworks/springboot-integration/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ implementation("io.flamingock:flamingock-springboot-integration-v2-legacy:$flami
120120

121121
Flamingock provides two editions for Spring Boot integration.
122122

123-
### Why are there two Spring Boot integration community-audit-stores artifacts?
123+
### Why are there two Spring Boot integration artifacts?
124124

125125
The only difference is the Java version they target:
126126

docs/overview/audit-store-vs-target-system.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Flamingock's architecture separates business changes from execution tracking thr
1717
- **Examples**: User database, Product catalog, Order management system, Kafka topics, S3 buckets, REST APIs
1818
- **Purpose**: Store and process your business data and configurations
1919
- **Modified by**: Your business logic through ChangeUnits
20-
- **Configuration**: See [Target System Configuration](../flamingock-library-config/target-system-configuration.md) for technical setup
20+
- **Configuration**: See [Target Systems](../target-systems/introduction.md) for technical setup
2121

2222
### Audit store: where execution is tracked
2323
**Audit store** is Flamingock's dedicated system for tracking what happened:
2424

2525
- **Examples**: Flamingock Cloud backend or dedicated audit table/collection in the user's database.
2626
- **Purpose**: Record execution history, compliance data, issue tracking
2727
- **Modified by**: Flamingock framework automatically (never your code)
28-
- **Configuration**: See [Audit Store Configuration](../flamingock-library-config/audit-store-configuration.md) for technical setup
28+
- **Configuration**: See [Audit Stores](../audit-stores/introduction.md) for technical setup
2929

3030

3131
## Why this separation matters
@@ -60,7 +60,7 @@ Systems without native transaction support (Kafka, S3, REST APIs, File Systems):
6060
Flamingock Cloud provides a fully managed audit store with superior synchronization and recovery through advanced coordination protocols, real-time dashboards, advanced analytics, and multi-environment governance.
6161

6262
### Community Audit Stores audit store
63-
User-provided audit store (MongoDB, DynamoDB, Couchbase) that ensures complete execution tracking, prevents duplicate executions, and provides basic recovery capabilities. See [Community audit store configuration](../flamingock-library-config/audit-store-configuration.md) for setup.
63+
User-provided audit store (MongoDB, DynamoDB, Couchbase) that ensures complete execution tracking, prevents duplicate executions, and provides basic recovery capabilities. See [Audit stores](../audit-stores/introduction.md) for setup.
6464

6565

6666

@@ -137,7 +137,7 @@ User-provided audit store (MongoDB, DynamoDB, Couchbase) that ensures complete e
137137
### For developers
138138
- **Target systems**: Where your business logic runs and makes changes
139139
- **Audit store**: Automatically managed by Flamingock for tracking and compliance
140-
- **Implementation**: See [Target System Configuration](../flamingock-library-config/target-system-configuration.md) and [Audit Store Configuration](../flamingock-library-config/audit-store-configuration.md)
140+
- **Implementation**: See [Target Systems](../target-systems/introduction.md) and [Audit Stores](../audit-stores/introduction.md)
141141

142142
### For architects
143143
- **Clean separation**: Business logic separated from execution tracking

docs/overview/core-concepts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ChangeUnits can be implemented in two forms:
1818
- **Code-based**: Java classes with annotations that contain the change logic
1919
- **Template-based**: Declarative low-code approach using YAML configurations
2020

21-
For a deeper dive around ChangeUnits, see the [ChangeUnits deep dive](../flamingock-library-config/changeunits-deep-dive.md) section.
21+
For a deeper dive around ChangeUnits, see the [ChangeUnits](../change-units/anatomy-and-structure.md) section.
2222

2323

2424
### Templates
@@ -44,7 +44,7 @@ Flamingock provides two main strategies:
4444

4545
The choice of strategy depends on whether your changes are idempotent and how critical they are to your system's integrity.
4646

47-
For detailed configuration and implementation, see the [Recovery configuration](../flamingock-library-config/recovery-configuration.md) section.
47+
For detailed configuration and implementation, see the [Recovery strategies](../recovery-and-safety/recovery-strategies.md) section.
4848

4949

5050
## Audit store
@@ -53,7 +53,7 @@ The **audit store** is where Flamingock records metadata about change executions
5353
## Target system
5454
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.
5555

56-
For more details about how these systems work together, see the [Audit store vs target system](../overview/audit-store-vs-target-system.md) section.
56+
For more details about how these systems work together, see the [Audit store vs target system](audit-store-vs-target-system.md) section.
5757

5858

5959
## Transaction handling

0 commit comments

Comments
 (0)