Dokumentation

Übersicht

Tutorials
Anleitungen
Infrastruktur
Referenz
Erklärung
Auf dieser Seite

Eine Datenquelle kommt auf einem von drei Wegen ins Verzeichnis: Selbstpublikation, Übernahme oder dokumentierte Zustimmung. Welcher Weg passt, hängt davon ab, wer die Beschreibung schreibt und führt.

Welcher Weg passt

WegAusgangslageWas der Betreiber tutHeute
SelbstpublikationSie beschreiben Ihre Quelle selbst und führen den Eintrag selbst.Publiziert das Manifest unter /.well-known/ der eigenen Domain; jede Schnittstelle wird vor der Aufnahme live verifiziert.offen — Phase 2 der Plattform
ÜbernahmeEine Beschreibung Ihrer Quelle existiert bereits.Übernimmt sie und führt sie ab dann selbst.in Betrieb — in Schriftform gegenüber dem Verein
Dokumentierte ZustimmungSie stimmen der Führung eines Eintrags zu.Erklärt die Zustimmung in dokumentierter Form; sie ist Teil des Registers.in Betrieb — in Schriftform gegenüber dem Verein

Der Weg heute, Schritt für Schritt

  1. Manifest entwerfen. Nach dem Manifest-Standard; das Tutorial Ein Manifest in 15 Minuten führt hin.
  2. Selbst prüfen. Gegen das datierte JSON-Schema; unbekannte Schlüssel sind Fehler.
  3. Erklärung in Schriftform. Manifest und Erklärung (Übernahme oder Zustimmung, für welche Quelle, durch wen) an [email protected]. Die Erklärung wird im Register festgehalten. Eine Bearbeitungsfrist ist nicht beschlossen.
  4. Verifikation. Jede Schnittstelle wird live geprüft, mit der minimalen unschädlichen Probe, die das Manifest selbst nennt (probe: kind → expect). Der Verifikationsstand ist Teil des Registers.
  5. Der Eintrag erscheint. Im Index /directory.json, als byte-identische Kopie unter /directory/{slug}/manifest.json und als HTML-Seite je Sprache. Bei jeder Abweichung zwischen Index und Manifest gilt das Manifest.

Für Maschinen

Derselbe Weg, zeigerbasiert: /.well-known/openhelvetia.json (Identität und Zeiger; pointers.publish zeigt auf die Dokumentation), /directory.json (der Index), /llms.txt (Orientierung).