Skip to content

Commit 7e6bc35

Browse files
committed
title style
1 parent 93e586f commit 7e6bc35

Some content is hidden

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

41 files changed

+104
-256
lines changed

.claude/settings.local.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@
99
"Bash(npm start)",
1010
"Bash(npx docusaurus:*)",
1111
"Bash(rm:*)",
12-
"Bash(git add:*)"
12+
"Bash(git add:*)",
13+
"Bash(yarn start)",
14+
"Bash(PORT=3001 yarn start)"
1315
],
1416
"deny": []
1517
}

CLAUDE.md

Lines changed: 75 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -74,34 +74,81 @@ Flamingock is a **"Change-as-Code" platform** that versions and orchestrates any
7474
- **Complete audit trail**: Every action, success, and failure is tracked
7575
- **Deterministic state**: Always know exactly what happened and what needs to happen next
7676

77-
## CRITICAL: Flamingock Positioning Strategy
78-
79-
**The validated dual positioning approach for Flamingock:**
80-
81-
### 1. Community Edition (Developer-First, Bottom-Up)
82-
- **Message**: "Manage all your changes alongside your app, like Liquibase but for the whole stack."
83-
- **Goal**: Broad adoption by developers, ease of use, speed, and confidence in local/dev environments
84-
- **Target**: Individual developers and small teams looking for practical change management
85-
86-
### 2. Cloud/Self-Hosted Edition (Enterprise, Top-Down)
87-
- **Message**: "Audit, govern, and secure those changes at scale, like LaunchDarkly but for compliance."
88-
- **Goal**: Monetization, governance, compliance, observability, and premium features for enterprises
89-
- **Target**: Enterprise teams requiring governance, compliance, and organizational control
90-
91-
**KEY INSIGHT**: Flamingock is developer-first for adoption and enterprise-ready for business.
92-
93-
### Edition Positioning
94-
- **Community Audit Stores**: Secure + Functional
95-
- Complete safety guarantees
96-
- Manual intervention when needed
97-
- Full audit capabilities
98-
- Covers essential enterprise needs
99-
100-
- **Cloud Edition**: Secure + Resilient + Automatic
101-
- Same configuration options as Community
102-
- Enhanced automatic resolution through advanced mechanisms
103-
- Better resilience through markers and reconciliation
104-
- Premium value: "Same settings, better outcomes"
77+
# CRITICAL: Flamingock Positioning Strategy
78+
79+
**Validated dual positioning approach for Flamingock**
80+
Flamingock combines a **developer-first adoption path** with **enterprise-grade governance and control**, ensuring both grassroots traction and organizational readiness.
81+
82+
---
83+
84+
## 1. Community Edition (Developer-First, Bottom-Up)
85+
86+
- **Message**
87+
*“Apply changes to your systems alongside your application code — safe, versioned, and auditable by default.”*
88+
89+
- **Core Benefits**
90+
- **Change-as-Code**: keep application and system changes in lockstep.
91+
- **Safe by default**: idempotent retry and manual intervention ensure reliability.
92+
- **Developer experience**: no extra pipelines, no manual scripts — changes run automatically at app startup.
93+
- **Transparency**: every change is versioned, ordered, and tracked.
94+
- **Lightweight templates**: ready-to-use drivers and official templates for common systems (MongoDB, DynamoDB, configs, etc.).
95+
96+
- **Goal**
97+
- Drive adoption by becoming the easiest, most natural way for developers to manage changes across their stack.
98+
99+
- **Target**
100+
- Individual developers and small teams looking for simplicity, speed, and confidence in local and dev environments.
101+
102+
---
103+
104+
## 2. Cloud / Self-Hosted Edition (Enterprise, Top-Down)
105+
106+
- **Message**
107+
*“Audit, govern, and secure system changes at scale, with enterprise-grade visibility, safety, and organizational control.”*
108+
109+
- **Core Benefits**
110+
- **Advanced recovery**: automated safe retry keeps the system consistent across failures.
111+
- **Governance workflows**: approval steps, human-in-the-loop, and compliance checks.
112+
- **Observability**: centralized dashboards, monitoring, and audit logs across all services and teams.
113+
- **Security and control**: role-based access, policies, and multi-team environments.
114+
- **Premium templates**: advanced system integrations (e.g., Kafka/Avro schema evolution, multi-region S3 provisioning, advanced rollback strategies).
115+
- **More premium features**: additional enterprise-grade capabilities will continue to be added over time.
116+
117+
- **Goal**
118+
- Monetize adoption by providing the capabilities enterprises need for compliance, governance, resilience, and organizational scale.
119+
120+
- **Target**
121+
- Enterprises and larger teams requiring visibility, compliance, and organizational control over distributed system changes.
122+
123+
---
124+
125+
## KEY INSIGHT
126+
127+
Flamingock is:
128+
- **Developer-first for adoption** → intuitive, safe, and frictionless for engineers.
129+
- **Enterprise-ready for business** → governance, compliance, and automation at scale.
130+
131+
---
132+
133+
## SALES PITCH TO DEVELOPERS (No Hype)
134+
135+
*"Flamingock lets you apply changes to your systems the same way you version your code. No more manual scripts or ad-hoc processes. Every change is tracked, ordered, and safe to run. You focus on building, Flamingock makes sure your changes are applied consistently and reliably — from your laptop to production."*
136+
137+
---
138+
139+
## STRATEGIC NOTES
140+
141+
- **Do not use the word “migration”** — Flamingock does not perform migrations, it applies versioned changes.
142+
- **Recovery split**: Community offers baseline safety (idempotent retry + manual intervention). Cloud offers automation (safe retry + reconciliation).
143+
- **Templates strategy**:
144+
- Community → free templates for popular systems.
145+
- Cloud → premium templates for complex, enterprise-grade integrations.
146+
- **Premium features in Cloud**: governance, observability dashboards, org-level security, premium templates, automated recovery, and more premium features to be added.
147+
148+
---
149+
150+
👉 This structure leaves no ambiguity: adoption comes from **Community (developer-first)**, monetization and scale come from **Cloud (enterprise)**.
151+
105152

106153
## Flamingock Architecture
107154

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The audit store is where Flamingock records execution history and ensures safe c
1313

1414
> 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
16-
---
1716

1817
## Minimum setup
1918

@@ -71,15 +70,13 @@ Flamingock.builder()
7170
.run();
7271
```
7372

74-
---
7573

7674
## Supported versions
7775

7876
| Couchbase SDK | Couchbase Server | Support level |
7977
|--------------------------------|------------------|-----------------|
8078
| `java-client` 3.6.0+ | 7.0+ | Full support |
8179

82-
---
8380

8481
## Dependencies
8582

@@ -129,7 +126,6 @@ implementation("com.couchbase.client:java-client:3.7.0")
129126

130127
</Tabs>
131128

132-
---
133129

134130
## Configuration options
135131

@@ -158,7 +154,6 @@ Flamingock.builder()
158154

159155
⚠️ **Warning**: Ensure your Couchbase user has permissions to create collections if `autoCreate` is enabled.
160156

161-
---
162157

163158
## Next steps
164159

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The audit store is where Flamingock records execution history and ensures safe c
1313

1414
> 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
16-
---
1716

1817
## Minimum setup
1918

@@ -68,15 +67,13 @@ Flamingock.builder()
6867
.run();
6968
```
7069

71-
---
7270

7371
## Supported versions
7472

7573
| AWS SDK | DynamoDB | Support level |
7674
|--------------------------------|----------------|-----------------|
7775
| `dynamodb` 2.25.29+ | All versions | Full support |
7876

79-
---
8077

8178
## Dependencies
8279

@@ -132,7 +129,6 @@ implementation("software.amazon.awssdk:dynamodb-enhanced:2.28.0")
132129

133130
</Tabs>
134131

135-
---
136132

137133
## Configuration options
138134

@@ -162,7 +158,6 @@ Flamingock.builder()
162158
⚠️ **Warning**: Adjust capacity units based on your workload. Under-provisioning may cause throttling.
163159
Consider using **ON_DEMAND** billing mode for unpredictable workloads.
164160

165-
---
166161

167162
## Next steps
168163

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The audit store is where Flamingock records execution history and ensures safe c
1313

1414
> 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
16-
---
1716

1817
## Minimum setup
1918

@@ -87,7 +86,6 @@ MongoSyncAuditStore auditStore = MongoSyncAuditStore
8786
.withReadConcern(ReadConcern.LOCAL);
8887
```
8988

90-
---
9189

9290
## Supported versions
9391

@@ -96,7 +94,6 @@ MongoSyncAuditStore auditStore = MongoSyncAuditStore
9694
| `mongodb-driver-sync` 4.0–5.x | 3.6 – 7.0 | Full support |
9795
| `mongodb-driver-sync` 3.12.x | 3.4 – 4.4 | Legacy support |
9896

99-
---
10097

10198
## Dependencies
10299

@@ -146,7 +143,6 @@ implementation("org.mongodb:mongodb-driver-sync:5.2.0")
146143

147144
</Tabs>
148145

149-
---
150146

151147
## Configuration options
152148

@@ -180,7 +176,6 @@ Flamingock.builder()
180176
⚠️ **Warning**: lowering concerns (e.g. `LOCAL`, `w=1`) increases performance but reduces safety.
181177
Recommended only for dev/test environments.
182178

183-
---
184179

185180
## Next steps
186181

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ The audit store is where Flamingock records execution history and ensures safe c
1313

1414
> 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
16-
---
1716

1817
## Minimum setup
1918

@@ -83,7 +82,6 @@ MongoSpringDataAuditStore auditStore = MongoSpringDataAuditStore
8382
.withReadConcern(ReadConcern.LOCAL);
8483
```
8584

86-
---
8785

8886
## Supported versions
8987

@@ -96,7 +94,6 @@ Flamingock provides two editions for different Spring Data MongoDB versions:
9694

9795
Choose the edition that matches your Spring Data MongoDB and JDK version.
9896

99-
---
10097

10198
## Dependencies
10299

@@ -145,7 +142,6 @@ implementation("org.springframework.boot:spring-boot-starter-data-mongodb")
145142

146143
</Tabs>
147144

148-
---
149145

150146
## Configuration options
151147

@@ -192,7 +188,6 @@ Flamingock.builder()
192188
⚠️ **Warning**: lowering concerns (e.g. `LOCAL`, `w=1`) increases performance but reduces safety.
193189
Recommended only for dev/test environments.
194190

195-
---
196191

197192
## Spring Boot integration
198193

@@ -213,7 +208,6 @@ Spring Boot will automatically:
213208
- Apply configuration from `application.yml`
214209
- Set up the audit store
215210

216-
---
217211

218212
## Next steps
219213

docs/audit-stores/introduction.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,5 @@ public AuditStore auditStore(MongoClient mongoClient) {
6161
```
6262

6363

64-
---
6564

6665
**Key takeaway**: The audit store is critical for Flamingock's safety guarantees. Cloud Edition provides this fully managed, while Community Audit Stores requires you to configure one of the supported databases.

docs/flamingock-library-config/additional-configuration.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ This section includes additional settings for customizing defaults and adding co
1919
:::note
2020
These options can currently be defined using the Flamingock builder. Support for config file (outside Spring Boot) will be added in a future release
2121
:::
22-
---
2322

2423
## Metadata
2524

@@ -57,7 +56,6 @@ FlamingockStandalone
5756
</TabItem>
5857
</Tabs>
5958

60-
---
6159

6260
### Default Author
6361

@@ -83,7 +81,6 @@ FlamingockStandalone
8381
</TabItem>
8482
</Tabs>
8583

86-
---
8784

8885
## Disable flamingock process
8986

docs/flamingock-library-config/context-and-dependencies.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,5 @@ Remember that target system contexts are isolated. Dependencies in one target sy
9898
- **Global**: Shared services, utilities, application-wide configuration
9999
- **Framework**: Let Spring manage beans, services, and repositories
100100

101-
---
102101

103102
**Key takeaway**: Flamingock's hierarchical dependency resolution provides flexibility while maintaining clear separation of concerns. Use target system contexts for system-specific dependencies and global context for shared resources.

docs/flamingock-library-config/introduction.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ Configuration is divided into two distinct scopes:
1717

1818
- **Runtime configuration** includes optional parameters such as locking, metadata, author, etc., and can be provided via builder or (depending on the environment) a file.
1919

20-
---
2120

2221
## What you can configure
2322

@@ -35,7 +34,6 @@ Configuration is divided into two distinct scopes:
3534

3635
Each of these topics is explained in its own section.
3736

38-
---
3937

4038

4139

@@ -51,7 +49,6 @@ Runtime configuration (everything except the pipeline) can be applied in the fol
5149
You can combine both approaches. If a property is defined in both, the builder value takes precedence.
5250
:::
5351

54-
---
5552

5653
## Next steps
5754

0 commit comments

Comments
 (0)