Skip to content

Commit 4bf60bf

Browse files
committed
fix: resolve CI compilation failure and professionalize documentation
Replace CacheAdapter.evictByPrefix() calls with inline prefix-based eviction using keys() + evict(), since evictByPrefix is not yet available in the published v26.02.06 CacheAdapter artifact. Remove all emojis from documentation, professionalize language (remove "new features" phrasing), and fix ASCII diagram alignment.
1 parent cdc5c92 commit 4bf60bf

15 files changed

Lines changed: 572 additions & 526 deletions

File tree

docs/README.md

Lines changed: 44 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Welcome to the **fireflyframework-starter-data** starter documentation! This starter provides a standardized, production-ready foundation for building data processing microservices in the Firefly ecosystem.
44

5-
## 📖 What is fireflyframework-starter-data?
5+
## What is fireflyframework-starter-data?
66

77
`fireflyframework-starter-data` is an opinionated Spring Boot starter that provides two main capabilities:
88

@@ -50,7 +50,7 @@ Python bridge package for `fireflyframework-genai` with tools, pipeline steps, a
5050

5151
---
5252

53-
## 🚀 Quick Start
53+
## Quick Start
5454

5555
### Choose Your Path
5656

@@ -68,14 +68,14 @@ Python bridge package for `fireflyframework-genai` with tools, pipeline steps, a
6868

6969
---
7070

71-
## 📚 Documentation Structure
71+
## Documentation Structure
7272

7373
### [Data Jobs — Complete Guide](data-jobs/guide.md)
7474
Documentation for building orchestrated workflows (async and sync) in one place.
7575

7676
### [Data Enrichers](data-enrichers/README.md)
7777
Documentation for integrating with third-party providers:
78-
- **[Step-by-Step Guide](data-enrichers/enricher-microservice-guide.md)** - Complete guide from scratch
78+
- **[Step-by-Step Guide](data-enrichers/enricher-microservice-guide.md)** - Complete guide from scratch
7979
- **[Data Enrichment Reference](data-enrichers/data-enrichment.md)** - Complete reference guide
8080

8181
### [Common Documentation](common/README.md)
@@ -90,16 +90,15 @@ Shared concepts, architecture, and utilities:
9090
- **[API Reference](common/api-reference.md)** - Complete API documentation
9191
- **[Examples](common/examples.md)** - Real-world usage patterns
9292

93-
### [New Features](common/)
94-
Advanced capabilities added in this release:
93+
### [Advanced Capabilities](common/)
9594
- **[Data Quality Framework](common/data-quality.md)** - Rule-based validation and quality gates
9695
- **[Data Lineage Tracking](common/data-lineage.md)** - Provenance and audit trail
9796
- **[Data Transformation](common/data-transformation.md)** - Post-enrichment transformation pipelines
98-
- **[GenAI Bridge](common/genai-bridge.md)** - Native integration with fireflyframework-genai
97+
- **[GenAI Bridge](common/genai-bridge.md)** - Integration with fireflyframework-genai
9998

10099
---
101100

102-
## 🎯 Common Tasks
101+
## Common Tasks
103102

104103
### Getting Started
105104
- **[Install the library](#installation)** - Add to your project
@@ -118,7 +117,7 @@ Advanced capabilities added in this release:
118117

119118
---
120119

121-
## 📦 Installation
120+
## Installation
122121

123122
### Maven
124123

@@ -152,52 +151,52 @@ Add the following to your `pom.xml`:
152151

153152
---
154153

155-
## Key Features
154+
## Key Features
156155

157156
### Automatic Observability
158-
- **Distributed Tracing** - Micrometer integration with OpenTelemetry
159-
- **Metrics Collection** - Automatic metrics for all operations
160-
- **Health Checks** - Ready-to-use health check endpoints
161-
- **Comprehensive Logging** - Structured JSON logging
157+
- **Distributed Tracing** - Micrometer integration with OpenTelemetry
158+
- **Metrics Collection** - Automatic metrics for all operations
159+
- **Health Checks** - Ready-to-use health check endpoints
160+
- **Comprehensive Logging** - Structured JSON logging
162161

163162
### Automatic Resiliency
164-
- **Circuit Breaker** - Prevent cascading failures
165-
- **Retry Logic** - Exponential backoff with jitter
166-
- **Rate Limiting** - Protect external APIs
167-
- **Bulkhead Isolation** - Isolate failures
163+
- **Circuit Breaker** - Prevent cascading failures
164+
- **Retry Logic** - Exponential backoff with jitter
165+
- **Rate Limiting** - Protect external APIs
166+
- **Bulkhead Isolation** - Isolate failures
168167

169168
### Event-Driven Architecture
170-
- **Automatic Event Publishing** - Job and enrichment lifecycle events
171-
- **CQRS Integration** - Command/Query separation
172-
- **SAGA Support** - Distributed transaction patterns
173-
174-
### Data Quality & Lineage
175-
- **Quality Gates** - Rule-based validation with fail-fast and collect-all strategies
176-
- **Data Lineage** - Track provenance across enrichments and transformations
177-
- **Transformation Pipelines** - Composable field mapping and computed fields
178-
179-
### Enrichment Enhancements
180-
- **Fallback Chains** - Automatic provider failover with `@EnricherFallback`
181-
- **Per-Provider Resilience** - Independent circuit breaker, retry, rate limiter per provider
182-
- **Cost Tracking** - Per-provider call counting and cost reports
183-
- **Preview/Dry-Run** - Preview enrichment routing without execution
184-
- **SSE Streaming** - Real-time batch enrichment results via Server-Sent Events
185-
- **Job Timeouts** - Configurable per-stage timeout enforcement
169+
- **Automatic Event Publishing** - Job and enrichment lifecycle events
170+
- **CQRS Integration** - Command/Query separation
171+
- **SAGA Support** - Distributed transaction patterns
172+
173+
### Data Quality and Lineage
174+
- **Quality Gates** - Rule-based validation with fail-fast and collect-all strategies
175+
- **Data Lineage** - Track provenance across enrichments and transformations
176+
- **Transformation Pipelines** - Composable field mapping and computed fields
177+
178+
### Enrichment Capabilities
179+
- **Fallback Chains** - Automatic provider failover with `@EnricherFallback`
180+
- **Per-Provider Resilience** - Independent circuit breaker, retry, rate limiter per provider
181+
- **Cost Tracking** - Per-provider call counting and cost reports
182+
- **Preview/Dry-Run** - Preview enrichment routing without execution
183+
- **SSE Streaming** - Real-time batch enrichment results via Server-Sent Events
184+
- **Job Timeouts** - Configurable per-stage timeout enforcement
186185

187186
### GenAI Integration
188-
- **Native Bridge** - Python package for `fireflyframework-genai` integration
189-
- **AI Agent Tools** - Data enrichment and job management as agent tools
190-
- **Pipeline Steps** - Enrichment and quality gate steps for GenAI pipelines
187+
- **Native Bridge** - Python package for `fireflyframework-genai` integration
188+
- **AI Agent Tools** - Data enrichment and job management as agent tools
189+
- **Pipeline Steps** - Enrichment and quality gate steps for GenAI pipelines
191190

192191
### Developer Experience
193-
- **Abstract Base Classes** - Minimal boilerplate code
194-
- **Type-Safe APIs** - Compile-time safety
195-
- **Reactive Programming** - Non-blocking operations with Project Reactor
196-
- **Comprehensive Testing** - Test utilities and examples
192+
- **Abstract Base Classes** - Minimal boilerplate code
193+
- **Type-Safe APIs** - Compile-time safety
194+
- **Reactive Programming** - Non-blocking operations with Project Reactor
195+
- **Comprehensive Testing** - Test utilities and examples
197196

198197
---
199198

200-
## 🏗️ Architecture
199+
## Architecture
201200

202201
The library follows **Hexagonal Architecture** (Ports and Adapters):
203202

@@ -235,7 +234,7 @@ The library follows **Hexagonal Architecture** (Ports and Adapters):
235234

236235
---
237236

238-
## 📖 Documentation Index
237+
## Documentation Index
239238

240239
### By Feature
241240
- **[Data Jobs — Complete Guide](data-jobs/guide.md)** - Orchestrated workflows
@@ -251,7 +250,7 @@ The library follows **Hexagonal Architecture** (Ports and Adapters):
251250

252251
---
253252

254-
## 🤝 Support
253+
## Support
255254

256255
For questions, issues, or contributions:
257256
- Check the [Examples](common/examples.md) for common patterns
@@ -260,7 +259,7 @@ For questions, issues, or contributions:
260259

261260
---
262261

263-
## 📝 License
262+
## License
264263

265264
Copyright © 2024-2026 Firefly Software Solutions Inc. All rights reserved.
266265

docs/common/README.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This section contains documentation that applies to **both Data Jobs and Data Enrichers** - shared concepts, architecture, configuration, and utilities.
44

5-
## 📖 What's in Common Documentation?
5+
## What's in Common Documentation?
66

77
These topics are relevant whether you're building data jobs, data enrichers, or both:
88
- Architecture and design patterns
@@ -15,7 +15,7 @@ These topics are relevant whether you're building data jobs, data enrichers, or
1515

1616
---
1717

18-
## 📚 Core Documentation
18+
## Core Documentation
1919

2020
### Architecture & Design
2121

@@ -28,12 +28,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
2828
- Component interactions
2929

3030
**Topics covered**:
31-
- Dependency inversion and interface segregation
32-
- Pluggable adapters for different platforms
33-
- Reactive programming with Project Reactor
34-
- Event-driven architecture integration
35-
- CQRS pattern support
36-
- SAGA pattern for distributed transactions
31+
- Dependency inversion and interface segregation
32+
- Pluggable adapters for different platforms
33+
- Reactive programming with Project Reactor
34+
- Event-driven architecture integration
35+
- CQRS pattern support
36+
- SAGA pattern for distributed transactions
3737

3838
---
3939

@@ -51,12 +51,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
5151
- Resiliency configuration
5252

5353
**Topics covered**:
54-
- YAML configuration examples
55-
- Property reference
56-
- Environment profiles
57-
- Feature toggles
58-
- Connection configuration
59-
- Timeout and retry settings
54+
- YAML configuration examples
55+
- Property reference
56+
- Environment profiles
57+
- Feature toggles
58+
- Connection configuration
59+
- Timeout and retry settings
6060

6161
---
6262

@@ -70,12 +70,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
7070
- Integration with monitoring systems (Prometheus, Grafana, Jaeger, Grafana Tempo)
7171

7272
**Topics covered**:
73-
- Automatic tracing for all operations
74-
- Custom trace spans
75-
- Metrics for jobs and enrichments
76-
- Health check endpoints
77-
- Performance monitoring
78-
- Error tracking
73+
- Automatic tracing for all operations
74+
- Custom trace spans
75+
- Metrics for jobs and enrichments
76+
- Health check endpoints
77+
- Performance monitoring
78+
- Error tracking
7979

8080
---
8181

@@ -90,11 +90,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
9090
- Fallback strategies
9191

9292
**Topics covered**:
93-
- Resilience4j integration
94-
- Automatic resiliency for jobs and enrichments
95-
- Configuration examples
96-
- Custom resiliency strategies
97-
- Monitoring resiliency metrics
93+
- Resilience4j integration
94+
- Automatic resiliency for jobs and enrichments
95+
- Configuration examples
96+
- Custom resiliency strategies
97+
- Monitoring resiliency metrics
9898

9999
---
100100

@@ -108,11 +108,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
108108
- Best practices
109109

110110
**Topics covered**:
111-
- Automatic logging for all operations
112-
- Request/response logging
113-
- Error logging with stack traces
114-
- Performance logging
115-
- Integration with log aggregation systems (ELK, Splunk)
111+
- Automatic logging for all operations
112+
- Request/response logging
113+
- Error logging with stack traces
114+
- Performance logging
115+
- Integration with log aggregation systems (ELK, Splunk)
116116

117117
---
118118

@@ -127,12 +127,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
127127
- Best practices
128128

129129
**Topics covered**:
130-
- Testing data jobs
131-
- Testing data enrichers
132-
- Testing custom operations
133-
- Testing with MockWebServer
134-
- Testing resiliency patterns
135-
- Test coverage strategies
130+
- Testing data jobs
131+
- Testing data enrichers
132+
- Testing custom operations
133+
- Testing with MockWebServer
134+
- Testing resiliency patterns
135+
- Test coverage strategies
136136

137137
---
138138

@@ -147,11 +147,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
147147
- Best practices
148148

149149
**Topics covered**:
150-
- Setting up MapStruct
151-
- Creating mappers
152-
- Field mapping
153-
- Custom converters
154-
- Testing mappers
150+
- Setting up MapStruct
151+
- Creating mappers
152+
- Field mapping
153+
- Custom converters
154+
- Testing mappers
155155

156156
---
157157

@@ -164,11 +164,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
164164
- OpenAPI/Swagger documentation
165165

166166
**Topics covered**:
167-
- Data job endpoints
168-
- Data enrichment endpoints
169-
- Discovery endpoints
170-
- Health check endpoints
171-
- Custom operation endpoints
167+
- Data job endpoints
168+
- Data enrichment endpoints
169+
- Discovery endpoints
170+
- Health check endpoints
171+
- Custom operation endpoints
172172

173173
---
174174

@@ -183,14 +183,14 @@ These topics are relevant whether you're building data jobs, data enrichers, or
183183
- Advanced scenarios
184184

185185
**Topics covered**:
186-
- Complete working examples
187-
- Best practices
188-
- Common patterns
189-
- Integration scenarios
186+
- Complete working examples
187+
- Best practices
188+
- Common patterns
189+
- Integration scenarios
190190

191191
---
192192

193-
## 🎯 Common Tasks
193+
## Common Tasks
194194

195195
### I want to...
196196

@@ -220,14 +220,14 @@ These topics are relevant whether you're building data jobs, data enrichers, or
220220

221221
---
222222

223-
## 🔗 Related Documentation
223+
## Related Documentation
224224

225225
- **[Data Jobs — Complete Guide](../data-jobs/guide.md)** - For orchestrated workflows
226226
- **[Data Enrichers](../data-enrichers/README.md)** - For third-party provider integration
227227

228228
---
229229

230-
## 📋 Document Index
230+
## Document Index
231231

232232
### Architecture & Design
233233
- [architecture.md](architecture.md) - Hexagonal architecture and design patterns

0 commit comments

Comments
 (0)