-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathinterview-data-model.html
More file actions
297 lines (272 loc) · 12 KB
/
interview-data-model.html
File metadata and controls
297 lines (272 loc) · 12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
---
layout: minimal
title: Interview Data Model
description: Data model documentation for interview and video content.
breadcrumb: Interview Data Model
---
<article class="page">
{% include breadcrumbs.html %}
<header>
<h1>Interview Data Model</h1>
<p class="intro">This document describes the data model for the interview/video content on the site.</p>
</header>
<section>
<h2>Data Flow Overview</h2>
<h3>Rendered Diagram</h3>
<pre class="mermaid">
flowchart TB
subgraph Canonical["Canonical Data"]
interviews[_data/interviews.yml<br/>Interview records]
assets[_data/video_assets.yml<br/>Canonical video assets]
transcripts[_data/transcripts/*.yml<br/>Transcript entries referenced by video_assets]
end
subgraph Buckets["Video Buckets"]
oneoffs[_data/oneoff_videos.yml<br/>One-off video list]
scmc[_data/scmc_videos.yml<br/>SCMC video list]
end
subgraph Lookups["Lookup Tables"]
confs[_data/interview_conferences.yml<br/>Conference definitions]
comms[_data/interview_communities.yml<br/>Community definitions]
related[_data/interview_related_videos.yml<br/>Related talks + official playlists]
resources[_data/resources.yml<br/>Trusted source registry]
end
interviews <-->|video_asset_id / interview_id| assets
oneoffs -->|video_asset_id| assets
scmc -->|video_asset_id| assets
interviews -->|conference field| confs
interviews -->|community field| comms
interviews -->|interview_id / conference+year| related
confs -->|slug| resources
assets -..->|transcript_id| transcripts
</pre>
<script type="module">
import mermaid from "https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs";
mermaid.initialize({ startOnLoad: false, theme: "neutral" });
mermaid.run({ querySelector: ".mermaid" });
</script>
<h3>Diagram Source</h3>
<pre><code>flowchart TB
subgraph Canonical["Canonical Data"]
interviews[_data/interviews.yml<br/>Interview records]
assets[_data/video_assets.yml<br/>Canonical video assets]
transcripts[_data/transcripts/*.yml<br/>Transcript entries referenced by video_assets]
end
subgraph Buckets["Video Buckets"]
oneoffs[_data/oneoff_videos.yml<br/>One-off video list]
scmc[_data/scmc_videos.yml<br/>SCMC video list]
end
subgraph Lookups["Lookup Tables"]
confs[_data/interview_conferences.yml<br/>Conference definitions]
comms[_data/interview_communities.yml<br/>Community definitions]
related[_data/interview_related_videos.yml<br/>Related talks + official playlists]
resources[_data/resources.yml<br/>Trusted source registry]
end
interviews <-->|video_asset_id / interview_id| assets
oneoffs -->|video_asset_id| assets
scmc -->|video_asset_id| assets
interviews -->|conference field| confs
interviews -->|community field| comms
interviews -->|interview_id / conference+year| related
confs -->|slug| resources
assets -.->|transcript_id| transcripts</code></pre>
</section>
<section>
<h2>File Descriptions</h2>
<h3>Canonical Data Files</h3>
<h4><code>_data/interviews.yml</code></h4>
<p>The authoritative source for interview records. Each interview contains:</p>
<pre><code>items:
- id: string # Unique identifier (slug)
title: string # Display title
interviewees: [string] # List of interviewee names
interviewer: string # Usually "Mike Hall"
topic: string # Interview topic (optional)
conference: string # Conference name (references interview_conferences.yml)
conference_year: int # Year of conference (optional)
community: string # Community name (references interview_communities.yml)
recorded_date: date # When the interview was recorded
tags: [string] # Categorization tags
video_asset_id: string # video_assets.id</code></pre>
<h4><code>_data/video_assets.yml</code></h4>
<p>Canonical video asset records. The <code>id</code> is the primary key and permalink for a video, with one or more platform publications stored in <code>platforms[]</code>. Links back to interviews via <code>interview_id</code> (optional):</p>
<pre><code>items:
- id: string # Primary key / permalink
interview_id: string # Links to interviews.yml id (optional)
title: string # Canonical title
primary_platform: string # Preferred platform for defaults (optional)
source: string # Source identifier (optional, e.g., "ugtastic")
published_date: date # Primary published date (optional)
thumbnail: string # Primary thumbnail URL (optional)
thumbnail_local: string # Local thumbnail path (optional)
duration_seconds: int # Video length (optional)
duration_minutes: int # Video length (rounded, optional)
description: string # Canonical description (optional)
tags: [string] # Tags
transcript_id: string # References transcripts.yml id (optional)
platforms: # Per-platform publications
- platform: string # "vimeo", "youtube", "pechakucha", etc.
asset_id: string # Platform-specific video ID
url: string # Direct URL to video (optional)
embed_url: string # Embeddable player URL (optional)
title_on_platform: string
published_date: date # Publication date on platform (optional)
thumbnail: string # Platform thumbnail URL (optional)
thumbnail_local: string # Local thumbnail path (optional)
duration_seconds: int # Video length (optional)
duration_minutes: int # Video length (rounded, optional)
description: string # Platform description (optional)
source: string # Platform source identifier (optional)
playlist: string # Playlist name/label (optional)
video_url: string # Direct video file URL (PechaKucha)
image_url: string # Poster image (PechaKucha)</code></pre>
<h4><code>_data/transcripts/*.yml</code></h4>
<p>Canonical transcripts referenced by <code>video_assets.yml</code>. Each transcript is stored as its own data file keyed by transcript ID (file basename):</p>
<pre><code># File: _data/transcripts/<transcript_id>.yml
content: |
Transcript text...</code></pre>
<p><code>_data/transcripts.yml</code> remains as a legacy placeholder and is not the active transcript content source.</p>
<h3>Lookup Tables</h3>
<h4><code>_data/interview_conferences.yml</code></h4>
<p>Conference definitions referenced by interviews:</p>
<pre><code>conferences:
- slug: string # URL-friendly identifier
name: string # Full conference name (display)
conference: string # Conference series (matched by interviews.conference)
year: int # Conference year (matched by interviews.conference_year)
start_date: date # Conference start
end_date: date # Conference end
location: string # Venue location
description: string # Conference description</code></pre>
<h4><code>_data/interview_communities.yml</code></h4>
<p>Community definitions referenced by interviews:</p>
<pre><code>communities:
- slug: string # URL-friendly identifier
name: string # Full community name (matched by interviews.community)
description: string # Community description</code></pre>
<h4><code>_data/resources.yml</code></h4>
<p>Trusted source registry keyed by conference slug:</p>
<pre><code>source_policy: repository-only
conferences:
conference-slug:
- label: string # Source label
url: string # Absolute URL
kind: string # Optional source kind
notes: string # Optional context</code></pre>
<h4><code>_data/interview_related_videos.yml</code></h4>
<p>Optional related conference content for interview pages:</p>
<pre><code>conference_playlists:
- conference: string # Matched by interviews.conference
conference_year: int # Matched by interviews.conference_year
links:
- label: string # Display text
kind: string # e.g. "official-playlist"
url: string # External URL
items:
- interview_id: string # Matched by interviews.id
links:
- label: string # Display text
kind: string # e.g. "official-talk"
url: string # External URL
embed_url: string # Optional embeddable URL</code></pre>
<h3>Source Data Files</h3> <h4><code>_data/oneoff_videos.yml</code></h4>
<p>One-off videos (standalone talks and presentations):</p>
<pre><code>items:
- video_asset_id: string # References video_assets.yml id
slug: string # URL-friendly identifier
title: string # Video title
topic: string # Topic (optional)
speaker: string # Speaker name (optional)
people: [string] # People featured (optional)
speakers: [string] # Speakers list (optional)
created: date # Creation date
tags: [string] # Tags
views: int # View count (optional)
category: string # Category label (optional)
categories: [string] # Category list (optional)</code></pre>
<h4><code>_data/scmc_videos.yml</code></h4>
<p>SCMC (Software Craftsmanship McHenry County) recordings:</p>
<pre><code>items:
- video_asset_id: string # References video_assets.yml id
slug: string # URL-friendly identifier
title: string # Video title
topic: string # Topic (optional)
speakers: [string] # Speakers list (optional)
created: date # Creation date
tags: [string] # Tags
views: int # View count (optional)
category: string # Category label (optional)</code></pre>
</section>
<section>
<h2>Relationships</h2>
<table>
<thead>
<tr>
<th>From</th>
<th>To</th>
<th>Relationship</th>
<th>Field</th>
</tr>
</thead>
<tbody>
<tr>
<td>interviews</td>
<td>video_assets</td>
<td>N:1</td>
<td><code>video_asset_id</code></td>
</tr>
<tr>
<td>video_assets</td>
<td>interviews</td>
<td>N:1 (optional)</td>
<td><code>interview_id</code></td>
</tr>
<tr>
<td>oneoff_videos</td>
<td>video_assets</td>
<td>N:1</td>
<td><code>video_asset_id</code></td>
</tr>
<tr>
<td>scmc_videos</td>
<td>video_assets</td>
<td>N:1</td>
<td><code>video_asset_id</code></td>
</tr>
<tr>
<td>video_assets</td>
<td>transcripts</td>
<td>N:1 (optional)</td>
<td><code>transcript_id</code></td>
</tr>
<tr>
<td>interviews</td>
<td>conferences</td>
<td>N:1</td>
<td><code>conference</code> + <code>conference_year</code></td>
</tr>
<tr>
<td>interviews</td>
<td>communities</td>
<td>N:1</td>
<td><code>community</code> (name match)</td>
</tr>
<tr>
<td>conferences</td>
<td>resources</td>
<td>1:N</td>
<td><code>slug</code> → <code>resources.conferences[slug]</code></td>
</tr>
<tr>
<td>interviews</td>
<td>interview_related_videos</td>
<td>1:N (optional)</td>
<td><code>id</code> or <code>conference + conference_year</code></td>
</tr>
</tbody>
</table>
</section>
<section>
<h2>Maintenance</h2>
<p>Imports are complete. The canonical sources of truth are <code>interviews.yml</code> and <code>video_assets.yml</code>. Ongoing work focuses on pruning, deduping, and maintaining canonical metadata.</p>
</section>
</article>