Skip to content

Commit b8a14ed

Browse files
committed
docs: Clarify OSM Notes ecosystem relationships in Rationale.md
- Updated descriptions for OSM-Notes-Viewer and OSM-Notes-Ingestion to reflect their roles within the ecosystem. - Enhanced the note on JSON exports to specify the relationship with OSM-Notes-Data. - Improved references section to include a link to OSM-Notes-Data and provide a complete overview of the ecosystem.
1 parent ef0cff8 commit b8a14ed

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

docs/Rationale.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -269,8 +269,8 @@ Once the data warehouse is populated, the system provides:
269269
4. **JSON Export**: Validated JSON files for OSM-Notes-Viewer (sister project)
270270
5. **API-Ready Data**: Structured data ready for web APIs
271271

272-
**Note**: The JSON exports are consumed by the OSM-Notes-Viewer sister project, which provides the
273-
web interface for visualizing these analytics.
272+
**Note**: The JSON exports are consumed by OSM-Notes-Viewer (part of the 8-project ecosystem), which provides the
273+
web interface for visualizing these analytics. Viewer consumes data from OSM-Notes-Data (GitHub Pages), which is populated by Analytics export scripts.
274274

275275
## Relationship to Other Projects
276276

@@ -290,19 +290,19 @@ OSM-Notes/
290290
└── OSM-Notes-Data/ # JSON data files (GitHub Pages)
291291
```
292292

293-
### OSM-Notes-Ingestion (Sister Project - Upstream)
293+
### OSM-Notes-Ingestion (Base Project - Upstream)
294294

295295
- **Purpose**: Collects and stores raw note data from OSM
296296
- **Relationship**: Analytics reads from ingestion base tables
297-
- **Dependency**: Analytics requires ingestion to run first
298-
- **Level**: Sister project at same organizational level
297+
- **Dependency**: Analytics requires ingestion to run first (Ingestion is the base project)
298+
- **Role**: Base project - first created, foundation for all others
299299

300-
### OSM-Notes-Viewer (Sister Project - Downstream)
300+
### OSM-Notes-Viewer (Ecosystem Project - Downstream)
301301

302302
- **Purpose**: Web interface (web page) for visualizing analytics
303-
- **Relationship**: Viewer reads JSON exports from analytics
304-
- **Dependency**: Viewer requires analytics to generate JSON files
305-
- **Level**: Sister project at same organizational level
303+
- **Relationship**: Viewer consumes JSON files from OSM-Notes-Data (GitHub Pages), which is populated by Analytics export scripts
304+
- **Dependency**: Viewer requires OSM-Notes-Data (which is generated by Analytics)
305+
- **Data Flow**: Analytics → Data → Viewer
306306
- **Technology**: Web application (HTML/CSS/JavaScript)
307307

308308
### OSM-Notes-Common (Shared Library)
@@ -348,10 +348,11 @@ techniques, the project provides a scalable, maintainable solution for OSM Notes
348348

349349
## References
350350

351-
- [OSM-Notes-Ingestion](https://github.com/OSM-Notes/OSM-Notes-Ingestion) - Sister project
352-
(upstream)
353-
- [OSM-Notes-Viewer](https://github.com/OSM-Notes/OSM-Notes-Viewer) - Sister project (downstream)
351+
- [OSM-Notes-Ingestion](https://github.com/OSM-Notes/OSM-Notes-Ingestion) - Base project (upstream)
352+
- [OSM-Notes-Viewer](https://github.com/OSM-Notes/OSM-Notes-Viewer) - Ecosystem project (downstream, consumes Data)
353+
- [OSM-Notes-Data](https://github.com/OSM-Notes/OSM-Notes-Data) - JSON data files (populated by Analytics)
354354
- [OSM-Notes-Common](https://github.com/OSM-Notes/OSM-Notes-Common) - Shared library (Git submodule)
355+
- See [Main README](../README.md) for complete ecosystem overview (8 projects)
355356
- [DWH Star Schema ERD](DWH_Star_Schema_ERD.md) - Data warehouse design
356357
- [ETL Enhanced Features](ETL_Enhanced_Features.md) - ETL capabilities
357358
- [Main README](../README.md) - Project overview

0 commit comments

Comments
 (0)