You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: docs/README.md
+44-45Lines changed: 44 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
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.
4
4
5
-
## 📖 What is fireflyframework-starter-data?
5
+
## What is fireflyframework-starter-data?
6
6
7
7
`fireflyframework-starter-data` is an opinionated Spring Boot starter that provides two main capabilities:
8
8
@@ -50,7 +50,7 @@ Python bridge package for `fireflyframework-genai` with tools, pipeline steps, a
50
50
51
51
---
52
52
53
-
## 🚀 Quick Start
53
+
## Quick Start
54
54
55
55
### Choose Your Path
56
56
@@ -68,14 +68,14 @@ Python bridge package for `fireflyframework-genai` with tools, pipeline steps, a
68
68
69
69
---
70
70
71
-
## 📚 Documentation Structure
71
+
## Documentation Structure
72
72
73
73
### [Data Jobs — Complete Guide](data-jobs/guide.md)
74
74
Documentation for building orchestrated workflows (async and sync) in one place.
75
75
76
76
### [Data Enrichers](data-enrichers/README.md)
77
77
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
Copy file name to clipboardExpand all lines: docs/common/README.md
+53-53Lines changed: 53 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This section contains documentation that applies to **both Data Jobs and Data Enrichers** - shared concepts, architecture, configuration, and utilities.
4
4
5
-
## 📖 What's in Common Documentation?
5
+
## What's in Common Documentation?
6
6
7
7
These topics are relevant whether you're building data jobs, data enrichers, or both:
8
8
- Architecture and design patterns
@@ -15,7 +15,7 @@ These topics are relevant whether you're building data jobs, data enrichers, or
15
15
16
16
---
17
17
18
-
## 📚 Core Documentation
18
+
## Core Documentation
19
19
20
20
### Architecture & Design
21
21
@@ -28,12 +28,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
28
28
- Component interactions
29
29
30
30
**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
37
37
38
38
---
39
39
@@ -51,12 +51,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
51
51
- Resiliency configuration
52
52
53
53
**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
60
60
61
61
---
62
62
@@ -70,12 +70,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
70
70
- Integration with monitoring systems (Prometheus, Grafana, Jaeger, Grafana Tempo)
71
71
72
72
**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
79
79
80
80
---
81
81
@@ -90,11 +90,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
90
90
- Fallback strategies
91
91
92
92
**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
98
98
99
99
---
100
100
@@ -108,11 +108,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
108
108
- Best practices
109
109
110
110
**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)
116
116
117
117
---
118
118
@@ -127,12 +127,12 @@ These topics are relevant whether you're building data jobs, data enrichers, or
127
127
- Best practices
128
128
129
129
**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
136
136
137
137
---
138
138
@@ -147,11 +147,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
147
147
- Best practices
148
148
149
149
**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
155
155
156
156
---
157
157
@@ -164,11 +164,11 @@ These topics are relevant whether you're building data jobs, data enrichers, or
164
164
- OpenAPI/Swagger documentation
165
165
166
166
**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
172
172
173
173
---
174
174
@@ -183,14 +183,14 @@ These topics are relevant whether you're building data jobs, data enrichers, or
183
183
- Advanced scenarios
184
184
185
185
**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
190
190
191
191
---
192
192
193
-
## 🎯 Common Tasks
193
+
## Common Tasks
194
194
195
195
### I want to...
196
196
@@ -220,14 +220,14 @@ These topics are relevant whether you're building data jobs, data enrichers, or
220
220
221
221
---
222
222
223
-
## 🔗 Related Documentation
223
+
## Related Documentation
224
224
225
225
-**[Data Jobs — Complete Guide](../data-jobs/guide.md)** - For orchestrated workflows
226
226
-**[Data Enrichers](../data-enrichers/README.md)** - For third-party provider integration
227
227
228
228
---
229
229
230
-
## 📋 Document Index
230
+
## Document Index
231
231
232
232
### Architecture & Design
233
233
-[architecture.md](architecture.md) - Hexagonal architecture and design patterns
0 commit comments