Skip to content

Commit 002b867

Browse files
committed
Enhance README with project metadata and ecosystem documentation
- Added metadata section including title, description, version, last updated date, author, tags, and audience. - Introduced a new documentation section outlining the OSM-Notes ecosystem and links to relevant resources. - Updated project relationship diagrams for clarity and improved visualization of data flow.
1 parent b6fcff0 commit 002b867

1 file changed

Lines changed: 87 additions & 17 deletions

File tree

README.md

Lines changed: 87 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
---
2+
title: "OSM-Notes-Data"
3+
description: "JSON data files for OSM Notes Viewer and AI-assisted note resolution"
4+
version: "latest"
5+
last_updated: "2026-01-25"
6+
author: "AngocA"
7+
tags:
8+
- "data"
9+
- "json"
10+
- "github-pages"
11+
audience:
12+
- "developers"
13+
- "data-consumers"
14+
project: "OSM-Notes-Data"
15+
status: "active"
16+
---
17+
118
# OSM-Notes-Data
219

320
JSON data files for OSM Notes Viewer and AI-assisted note resolution.
@@ -103,6 +120,18 @@ See `index.html` for a complete list of available endpoints.
103120

104121
All data is exported from the OSM Notes Analytics data warehouse (`notes_dwh` database) using automated ETL processes. The export scripts are located in the [OSM-Notes-Analytics](https://github.com/OSM-Notes/OSM-Notes-Analytics) repository.
105122

123+
## 📚 Ecosystem Documentation
124+
125+
For shared documentation of the complete ecosystem, see:
126+
127+
- **[OSM Notes Ecosystem](https://github.com/OSM-Notes/OSM-Notes)** - Ecosystem landing page
128+
- **[Global Glossary](https://github.com/OSM-Notes/OSM-Notes-Common/blob/main/docs/GLOSSARY.md)** - Terms and definitions
129+
- **[Complete Installation Guide](https://github.com/OSM-Notes/OSM-Notes-Common/blob/main/docs/INSTALLATION.md)** - Step-by-step installation of all projects
130+
- **[End-to-End Data Flow](https://github.com/OSM-Notes/OSM-Notes-Common/blob/main/docs/DATA_FLOW.md)** - Complete data flow
131+
- **[Decision Guide](https://github.com/OSM-Notes/OSM-Notes-Common/blob/main/docs/DECISION_GUIDE.md)** - Which project do I need?
132+
133+
---
134+
106135
## 🌐 OSM-Notes Ecosystem
107136

108137
This Data repository is part of the **OSM-Notes ecosystem**, consisting of 8 interconnected projects.
@@ -160,28 +189,69 @@ served via GitHub Pages.
160189

161190
### Project Relationships
162191

163-
```
164-
OSM Planet/API
165-
166-
[OSM-Notes-Ingestion] ← Base project
167-
├─→ [OSM-Notes-Analytics] → ETL → Data Warehouse
168-
│ └─→ [OSM-Notes-Data] → JSON files (this repo, GitHub Pages)
169-
│ ├─→ [OSM-Notes-Viewer] → Primary consumer
170-
└─→ [OSM-Notes-API] → Optional consumer
171-
└─→ [OSM-Notes-WMS] → WMS layers
192+
```mermaid
193+
graph TB
194+
subgraph External["External Sources"]
195+
OSM[OSM Planet/API]
196+
end
197+
198+
subgraph Base["Base Project"]
199+
INGESTION[OSM-Notes-Ingestion<br/>Base project]
200+
end
172201
173-
[OSM-Notes-Monitoring] → Monitors Data freshness and sync status
174-
[OSM-Notes-Common] → Provides schemas (synced to Data/schemas/)
202+
subgraph Processing["Processing Layer"]
203+
ANALYTICS[OSM-Notes-Analytics<br/>ETL → Data Warehouse]
204+
WMS[OSM-Notes-WMS<br/>WMS layers]
205+
end
206+
207+
subgraph Delivery["Delivery Layer"]
208+
DATA[OSM-Notes-Data<br/>JSON files<br/>this repo, GitHub Pages]
209+
VIEWER[OSM-Notes-Viewer<br/>Primary consumer]
210+
API[OSM-Notes-API<br/>Optional consumer]
211+
end
212+
213+
subgraph Support["Support Layer"]
214+
MONITORING[OSM-Notes-Monitoring<br/>Monitors Data freshness<br/>and sync status]
215+
COMMON[OSM-Notes-Common<br/>Provides schemas<br/>synced to Data/schemas/]
216+
end
217+
218+
OSM -->|Downloads| INGESTION
219+
INGESTION -->|Base Tables| ANALYTICS
220+
INGESTION -->|Same Database| WMS
221+
ANALYTICS -->|JSON Export| DATA
222+
DATA -->|JSON Files| VIEWER
223+
DATA -->|JSON Files| API
224+
MONITORING -.->|Monitors| DATA
225+
COMMON -.->|Schemas| DATA
226+
227+
style OSM fill:#ADD8E6
228+
style INGESTION fill:#90EE90
229+
style ANALYTICS fill:#FFFFE0
230+
style WMS fill:#FFE4B5
231+
style DATA fill:#E0F6FF
232+
style VIEWER fill:#DDA0DD
233+
style API fill:#FFB6C1
234+
style MONITORING fill:#F0E68C
235+
style COMMON fill:#D3D3D3
175236
```
176237

177238
### Data Flow
178239

179-
```
180-
[OSM-Notes-Analytics] → exportAndPushJSONToGitHub.sh
181-
182-
[OSM-Notes-Data] → GitHub Pages (this repository)
183-
├─→ [OSM-Notes-Viewer] → Consumes JSON (primary consumer)
184-
└─→ [OSM-Notes-API] → Can consume JSON (optional)
240+
```mermaid
241+
flowchart TD
242+
ANALYTICS[OSM-Notes-Analytics<br/>exportAndPushJSONToGitHub.sh]
243+
DATA[OSM-Notes-Data<br/>GitHub Pages<br/>this repository]
244+
VIEWER[OSM-Notes-Viewer<br/>Consumes JSON<br/>primary consumer]
245+
API[OSM-Notes-API<br/>Can consume JSON<br/>optional]
246+
247+
ANALYTICS -->|Exports| DATA
248+
DATA -->|Serves| VIEWER
249+
DATA -->|Serves| API
250+
251+
style ANALYTICS fill:#FFFFE0
252+
style DATA fill:#E0F6FF
253+
style VIEWER fill:#DDA0DD
254+
style API fill:#FFB6C1
185255
```
186256

187257
### Installation Order

0 commit comments

Comments
 (0)