mirror of
https://github.com/skoelle/buildbroken-blog-archive.git
synced 2026-09-17 18:30:25 +00:00
242 lines
9.6 KiB
Markdown
242 lines
9.6 KiB
Markdown
# 🏗️ buildbroken-blog-archive
|
||
|
||
Statisches Archiv des ehemaligen **".NET/build broken"-Blogs** (`aztec-project.org/blog/`),
|
||
aufgebaut mit [Hugo](https://gohugo.io). Alle Inhalte stammen aus web.archive.org
|
||
Downloads und werden lokal gehostet (Bilder, CSS, Content).
|
||
|
||
> 💾 Die Blogartikel unter `content/posts/` und die zugehörigen Bilder wurden
|
||
> ursprünglich von den Autoren von "build broken" (aztec-project.org, 2009–2010)
|
||
> geschrieben und werden hier ausschließlich zu persönlichen Archivierungszwecken
|
||
> aufbewahrt. Das Urheberrecht verbleibt bei den ursprünglichen Autoren; die
|
||
> MIT-Lizenz dieses Repositories gilt nur für den Code (Parser-Skripte,
|
||
> Hugo-Templates und CSS), nicht für die archivierten Bloginhalte selbst.
|
||
|
||
---
|
||
|
||
## 🔗 URL-Struktur
|
||
|
||
| 🏷️ Bereich | 🌐 Alte URL (Wayback) | 📍 Neue lokale URL |
|
||
|---|---|---|
|
||
| Startseite (inkl. About-Text) | `blog/blog.html` | `/` |
|
||
| About | `blog/about.html` | `/` (Text liegt auf der Startseite) |
|
||
| Blogartikel | `blog/<slug>.html` | `/posts/<slug>/` |
|
||
| 🖼️ Bilder | extern/beliebig | `/images/<slug>/<dateiname>` |
|
||
| 🎨 CSS | Theme-CSS | `/css/style.css` |
|
||
|
||
`<slug>` ist der ursprüngliche Dateiname ohne `.html`, durch `python-slugify`
|
||
normalisiert (Kleinschreibung, Bindestriche). Beispiel:
|
||
`dotnet-openspace-leipzig-2009-buchung.html` → `/posts/dotnet-openspace-leipzig-2009-buchung/`.
|
||
|
||
🔗 Interne Links zwischen Artikeln werden vom Parser automatisch von
|
||
`https://aztec-project.org/blog/xyz.html` auf `/posts/xyz/` umgeschrieben.
|
||
|
||
---
|
||
|
||
## 🛠️ Voraussetzungen
|
||
|
||
- 🐢 [Hugo](https://gohugo.io/installation/) (extended oder normal reicht, kein Node nötig)
|
||
- 🐍 Python 3.10+
|
||
- 📦 `pip install -r scripts/requirements.txt`
|
||
|
||
---
|
||
|
||
## 📁 Ordnerstruktur
|
||
|
||
```
|
||
buildbroken-blog-archive/
|
||
├── hugo.toml # ⚙️ Hugo-Konfiguration
|
||
├── content/
|
||
│ ├── _index.md # 🏠 Startseite (About-Text liegt hier, kein eigenes /about/)
|
||
│ ├── categories/ # 📂 pro Kategorie eine _index.md mit Einleitungstext
|
||
│ ├── tags/ # 🏷️ pro Tag eine _index.md mit Einleitungstext
|
||
│ └── posts/ # 📝 wird vom Parser mit *.md befüllt
|
||
├── layouts/ # 🎨 eigenes Theme, angelehnt an das Original-Design
|
||
│ ├── _default/baseof.html
|
||
│ ├── _default/single.html
|
||
│ ├── _default/list.html
|
||
│ ├── _default/term.html
|
||
│ └── index.html
|
||
├── static/
|
||
│ ├── css/style.css
|
||
│ └── images/<slug>/... # 🖼️ wird vom Parser befüllt
|
||
├── archive/
|
||
│ └── wayback-html/ # 📥 HIER die heruntergeladenen Wayback-HTML-Dateien ablegen
|
||
├── scripts/
|
||
│ ├── parse_buildbroken_archive.py
|
||
│ └── requirements.txt
|
||
├── URLS.md # 📋 Liste aller zu parsenden Quell-URLs/Dateien
|
||
└── TODO.md # 📌 Arbeitsauftrag für die lokale KI
|
||
```
|
||
|
||
---
|
||
|
||
## 🚀 Ablauf
|
||
|
||
### 1⃣ HTML herunterladen
|
||
|
||
Alle Dateien aus `URLS.md` als HTML von web.archive.org herunterladen und
|
||
unter `archive/wayback-html/<dateiname>.html` ablegen (exakt gleicher Name).
|
||
|
||
### 2⃣ Parser laufen lassen
|
||
|
||
```bash
|
||
cd scripts
|
||
pip install -r requirements.txt
|
||
python parse_buildbroken_archive.py --source ../archive/wayback-html --output .. --download-images
|
||
```
|
||
|
||
> ⚠️ **Wichtig:** Der Parser soll **nicht mehr erneut ausgeführt** werden. Die
|
||
> generierten Artikel in `content/posts/*.md` wurden nachträglich manuell
|
||
> ausgebessert (Titel gekürzt, Tags korrigiert, `alt`-Attribute ergänzt,
|
||
> Links umgeschrieben. Ein erneuter Lauf würde diese Handarbeit überschreiben.
|
||
|
||
### 3⃣ Lokale Vorschau
|
||
|
||
```bash
|
||
cd ..
|
||
hugo server -D --bind 0.0.0.0 --baseURL http://<hostname>:1313/
|
||
```
|
||
|
||
`<hostname>` durch den Hostnamen des Rechners ersetzen (z. B. `xubuntu-dev.lan`).
|
||
|
||
### 4⃣ Produktions-Build
|
||
|
||
```bash
|
||
hugo --minify
|
||
```
|
||
|
||
🌍 Ergebnis liegt in `public/` und kann auf beliebigem statischen Hosting
|
||
(nginx-Container, Gitea Pages, GitHub Pages) deployt werden.
|
||
|
||
---
|
||
|
||
## 🔍 Link-Status (tote Links kennzeichnen)
|
||
|
||
🔗 Externe Links in Artikeln und Kommentaren werden in `data/links.json` gepflegt
|
||
und clientseitig (`static/js/link-status.js`) verarbeitet:
|
||
|
||
- 🚫 **`broken`**: Die URL wird im Text normal angezeigt, aber beim Klick öffnet
|
||
sich ein kleines Modal "Diese URL scheint nicht mehr verfügbar zu sein" mit
|
||
einem Button zur Web-Archive-Version (`https://web.archive.org/web/*/<url>`).
|
||
- 🔄 **`replacement`**: Die URL wird automatisch auf eine nachgewiesene
|
||
Nachfolge-URL umgeschrieben (z. B. `codinghorror.com` → `blog.codinghorror.com`).
|
||
|
||
### 🔧 Link-Checker
|
||
|
||
Der Link-Checker `scripts/check_links.py` prüft alle tatsächlich gerenderten
|
||
`<a href>`-Links und aktualisiert `data/links.json`:
|
||
|
||
```bash
|
||
.venv/bin/python scripts/check_links.py # 🔍 prüfen + data/links.json aktualisieren
|
||
.venv/bin/python scripts/check_links.py --check-only # 👀 nur prüfen, nichts schreiben
|
||
```
|
||
|
||
### ⚙️ Verhalten des Checkers
|
||
|
||
- 📖 Er liest die Links aus dem **gebauten** `public/` (vorher `hugo --minify`),
|
||
damit nur echte Links erfasst werden (Code-Beispiele/Platzhalter ignoriert).
|
||
- 🛡️ HTTP 403/429 (Bot-Schutz) und DNS-/Timeout-Fehler (ERR) werden **nicht**
|
||
als neu broken gemeldet; bestehende broken-Einträge bleiben erhalten,
|
||
solange die URL nicht eindeutig wieder mit 200 antwortet.
|
||
- ✏️ Manuelle `replacement`-Einträge werden nie überschrieben.
|
||
- 🔄 Das Skript ist idempotent: ein Lauf ohne Änderungen meldet "0 neu / 0 entfernt".
|
||
|
||
---
|
||
|
||
## ☁️ Hosting (Cloudflare Pages, migriert in Workers)
|
||
|
||
Das Projekt wird über die Cloudflare-Pages-**Git-Integration** deployed
|
||
(Pages wurde inzwischen in den Workers-Bereich migriert, das Prinzip ist
|
||
unverändert):
|
||
|
||
1. 📦 **GitHub-Repo** anlegen und dieses Projekt hineinpushen.
|
||
2. ☁️ In Cloudflare unter **Workers & Pages → Create application → Pages** den
|
||
Tab **Import an existing Git repository** wählen und das Repo auswählen.
|
||
3. ⚙️ Build-Einstellungen hinterlegen:
|
||
- **Framework preset:** Hugo
|
||
- **Build command:** `hugo --minify`
|
||
- Ein eigenes **Build output directory** kann bei Cloudflare Pages nicht
|
||
angegeben werden — es kommt aus der Hugo-Konfiguration (`publishDir` in
|
||
`hugo.toml`, Standard `public`).
|
||
4. 💾 Speichern. Es ist **kein Deploy-Befehl nötig**: Jeder Push auf den
|
||
verbundenen GitHub-Branch (z. B. `main`) baut und deployed automatisch.
|
||
|
||
### ⚙️ wrangler.json
|
||
|
||
Die `wrangler.json` im Projekt-Root konfiguriert das Deployment:
|
||
|
||
| Parameter | Wert | Beschreibung |
|
||
|---|---|---|
|
||
| `name` | `buildbroken-blog-archive` | 🏷️ Projektname |
|
||
| `compatibility_date` | Datum | 📅 Cloudflare-Laufzeit |
|
||
| `assets.directory` | `public` | 📂 Hugo-Ausgabeverzeichnis |
|
||
| `assets.not_found_handling` | `404-page` | 🔀 Eigene 404.html statt generischem 404 |
|
||
|
||
---
|
||
|
||
## 📈 SEO
|
||
|
||
Das Layout erzeugt für jede Seite automatisch SEO-Metadaten (zentral in
|
||
`layouts/_default/baseof.html`):
|
||
|
||
- 📝 `meta name="description"` (aus Frontmatter/`.Description`, sonst aus `.Summary`)
|
||
- 🔗 `link rel="canonical"` mit der absoluten URL
|
||
- 🐦 Open-Graph- und Twitter-Card-Tags (`og:type`, `og:image`, `twitter:card`)
|
||
- 🏷️ `<title>`: Tag- und Kategorie-Seiten werden differenziert (`MVC (Tag)` vs. `MVC (Kategorie)`), Länge auf ~60 Zeichen begrenzt
|
||
|
||
### 🏠 Startseite
|
||
|
||
Für die Startseite wird ein eigener `<title>` über `params.homeTitle` in
|
||
`hugo.toml` konfiguriert (statt nur dem bloginfo `title`). Die Description
|
||
der Startseite kommt aus `params.description`.
|
||
|
||
### ✅ Zusätzlich
|
||
|
||
- 🔀 Eigene `layouts/_default/404.html`, die via `assets.not_found_handling` von Cloudflare ausgeliefert wird
|
||
- 🤖 `robots.txt` verweist auf `sitemap.xml` (Hugo-generiert)
|
||
- 🖼️ Content-Bilder in `content/posts/*.md` tragen `alt`-Attribute; der dekorative Banner hat bewusst leeres `alt=""`
|
||
|
||
---
|
||
|
||
## 📂 Kategorien & Tags
|
||
|
||
Kategorie- und Tag-Seiten können individuelle Einleitungstexte haben. Dafür
|
||
legt man in `content/categories/<name>/_index.md` bzw. `content/tags/<name>/_index.md`
|
||
eine Datei mit Front Matter und Body-Text an:
|
||
|
||
```markdown
|
||
---
|
||
title: "Clean Code Developing"
|
||
---
|
||
|
||
Die Grundlage unserer Arbeit: SOLID, DRY, Refactoring und professionelle Software-Entwicklung.
|
||
```
|
||
|
||
Der `title` in der Front Matter bestimmt die `<h2>`-Überschrift auf der Seite.
|
||
**Wichtig:** Die Groß-/Kleinschreibung muss korrekt sein (z. B. `C#`, `MVC`,
|
||
`Visual Studio`), da Hugo den slug automatisch kleinschreibt (URL: `/tags/c#/`).
|
||
|
||
Der Body-Text wird als `<div class="archive-intro">` zwischen Überschrift und
|
||
Artikelliste gerendert (via `layouts/_default/term.html`). Ohne Body-Text
|
||
wird kein `<div>` generiert — die Seiten funktionieren auch ohne Einleitungstexte.
|
||
|
||
**Aktuelle Kategorien (17):** Architektur, BarCamp, Clean Code Developing, How-To,
|
||
MVC, Open Space, Pattern, prio.conference, Release, Scrum, StupidDB, Tipps,
|
||
Unit Testing, Veranstaltung, Visual Studio Addins, Webanwendungen, Webservice.
|
||
|
||
**Aktuelle Tags (43):** Addin, Architektur, ASP-Classic, Assemblies, Assembly,
|
||
Basics, Buch, Buchempfehlung, C#, CCD, Clean Code, Coding, Community,
|
||
Contract-First, Datenbank, Datenschutz, Facebook, HowTo, HTML, MVC, MVP,
|
||
NoSQL, Open Space, Patterns, Plug-In, prio.conference, Refaktorisierung,
|
||
Reflection, Schemalos, SCRUM, Social Web, Sonne, Sourcecode, StupidDB,
|
||
Unit Tests, Veranstaltung, Visual Studio, Webapplication, WebCamp, WebCast,
|
||
Webservice, WinForms, Wordpress.
|
||
|
||
---
|
||
|
||
## 🎨 Layout anpassen
|
||
|
||
Alle Design-Änderungen passieren zentral in `layouts/_default/*.html` und
|
||
`static/css/style.css`. Nach einer Änderung reicht `hugo --minify`, um alle
|
||
Artikel neu zu bauen — der Content in `content/posts/*.md` bleibt unangetastet.
|