Die GitHub-Inhaltssynchronisierung ermöglicht es Ihnen, Markdown (.md) Dateien aus einem GitHub-Repository in Fin zu synchronisieren, damit Fin und Copilot sie verwenden können.
Erste Schritte
Gehen Sie zu Train > Content, klicken Sie auf Alle anzeigen und wählen Sie dann Von GitHub.
Installieren Sie die Fin GitHub-Sync-App für das GitHub-Konto, das Sie verbinden möchten. Möglicherweise benötigen Sie die Genehmigung Ihres Organisationsadministrators, um die App auf einem Organisationskonto zu installieren.
Wählen Sie aus, ob die App auf alle Repositories oder nur auf ausgewählte zugreifen darf.
Wenn die GitHub-Einrichtung abgeschlossen ist, schließt sich das Pop-up-Fenster. Wählen Sie das Repository und gegebenenfalls einen Ordner aus, von dem Sie Markdown-Dateien synchronisieren möchten.
(Optional) Wählen Sie, ob eine
CLAUDE.md-Datei mit Anweisungen für Claude Code erstellt oder aktualisiert werden soll, wie synchronisierte Inhalte erstellt und aktualisiert und das Frontmatter-Schema verwendet wird.Klicken Sie auf Klone und verbinden.
Hinweis: Um später den Zugriff auf ein anderes Repository zu gewähren, klicken Sie auf GitHub-Repository-Zugriff auf GitHub verwalten. Dadurch wird dasselbe Pop-up-Fenster geöffnet, in dem Sie Repositories zur Zulassungsliste hinzufügen können.
Berechtigungen
Die Fin GitHub-Sync-App benötigt diese GitHub-Berechtigungen:
Metadaten (nur lesen): Der Standardscope, den jede GitHub-App hat.
Checks (lesen und schreiben): Führt die im Abschnitt PR-Checks beschriebenen Frontmatter-Schema-Prüfungen durch.
Code (lesen und schreiben): Erstellt oder aktualisiert die
CLAUDE.md-Datei. Das Erstellen der Datei ist optional, aber die Berechtigung ist erforderlich.Pull Requests (lesen und schreiben): Erstellt die
CLAUDE.md-Datei und empfängt die Webhooks, die Änderungen mit Fin synchronisieren und PR-Checks ausführen.Workflows (lesen und schreiben): Fügt den GitHub Actions-Workflow hinzu, der es Ihrem Repository ermöglicht, Fin’s Vorschlags-Pull-Requests automatisch zu genehmigen und zusammenzuführen (optionale Auto-Merge-Einrichtung).
Wie die Synchronisierung funktioniert
Wenn Sie Ihr Repository zum ersten Mal verbinden, synchronisiert Fin alle Markdown-Dateien darin oder im ausgewählten Ordner. Danach wendet Fin Änderungen an diesen Markdown-Dateien automatisch an, sobald sie zusammengeführt werden.
(Optional) Frontmatter-Schema
Frontmatter ist nicht erforderlich. Wenn Ihre Markdown-Dateien es noch nicht verwenden, können Sie diesen Abschnitt überspringen. Frontmatter ermöglicht es Ihnen, zusätzliche Eigenschaften festzulegen, wie jede Datei in Fin synchronisiert wird. Fügen Sie es oben in Ihre Markdown-Datei ein, so:
---
title: How to request a refund
description: Steps to get a refund on your order
audience: everyone
published: true
fin: enabled
copilot: enabled
sales_agent: disabled
---
Article body goes here…
Unterstützte Schlüssel und Werte:
title (beliebiger Text): Der Artikeltitel. Wenn er fehlt, verwendet Fin die erste H1 oder eine lesbare Version des Dateinamens.
description (beliebiger Text): Eine kurze Beschreibung, die unter dem Artikeltitel angezeigt wird.
published oder state (
published,true,draftoderfalse): Ob der Artikel als veröffentlicht oder als Entwurf synchronisiert wird. Veröffentlicht bedeutet, dass der Inhalt live und für Fin verfügbar ist.public_url (beliebige URL): Die öffentliche URL, zu der Kunden geleitet werden, wenn Fin diesen Inhalt zitiert. Ohne diese URL zitiert Fin keine Quelle für den Artikel.
service_agent oder service (
enabledoderdisabled): Ob Fin den Artikel verwenden kann.copilot (
enabledoderdisabled): Ob Copilot den Artikel verwenden kann.sales_agent oder sales (
enabledoderdisabled): Ob Sales Agent den Artikel verwenden kann.
Alle Frontmatter-Schlüssel und -Werte sind optional. Nicht erkannte Schlüssel werden übersprungen.
PR-Checks
Fin führt leichte Prüfungen bei Pull Requests durch, die Ihre synchronisierten Markdown-Dateien ändern. Sie prüfen, ob jeder Frontmatter-Schlüssel gültig und unterstützt ist. Ein fehlgeschlagener Check wird im Prüfungsbereich des Pull Requests angezeigt, und Sie können darauf klicken, um Details zu sehen.
Hinweis: Diese Prüfungen verhindern nicht das Zusammenführen. Pull Requests können weiterhin zusammengeführt werden, wenn die GitSync: Content Validation-Prüfungen fehlschlagen. Um sie durchzusetzen, siehe GitHubs Anleitung zu Statusprüfungen vor dem Zusammenführen verlangen.
Bekannte Einschränkungen
Es werden nur Markdown (
.md) Dateien synchronisiert..mdx-Dateien werden noch nicht unterstützt.Synchronisierte Artikel sind standardmäßig für Fin, Copilot und Sales Agent deaktiviert, damit Sie sie vor der Veröffentlichung überprüfen können.
Dies ist eine Einweg-Synchronisierung von GitHub zu Fin. Synchronisierte Artikel sind in Fin schreibgeschützt und müssen in GitHub bearbeitet werden.
Artikel werden derzeit nur auf Englisch erstellt.
