Zusammenfassung: ◀▼
Sie können ein Help-Center-Design in GitHub mit der Wissensadministrator-Oberfläche verbinden und von dort aus eine Vorschau anzeigen oder Aktualisierungen veröffentlichen. Ihr Design-Repository muss genau ein Design sowie die Datei manifest.json auf der Root-Ebene des Repositorys enthalten. Diese Integration unterstützt die gemeinsame Verwaltung von Designs, das Testen anhand von Branches sowie GitHub Enterprise Cloud, aber nicht GitHub Enterprise Server.
) > Design hinzufügen > Aus GitHub hinzufügenDie GitHub-Integration ermöglicht Ihnen, ein Design gemeinsam mit anderen in GitHub zu entwickeln und zu pflegen und dann in der Wissensadministrator-Oberfläche zu veröffentlichen. Stellen Sie vor dem Einrichten der Integration in der Wissensadministrator-Oberfläche sicher, dass Ihr Design in GitHub gespeichert ist.
Die GitHub-Integration kann nur von einem Wissensadministrator eingerichtet werden.
Vorbereiten des Designs in GitHub
Bevor Sie die Integration in der Wissensadministrator-Oberfläche einrichten, müssen Sie sicherstellen, dass das Design in GitHub gespeichert ist. Wenn Sie noch keine Erfahrung mit Git und GitHub haben, lesen Sie dieses Tutorial. Wenn das Design bereits in GitHub gespeichert ist und den folgenden Anforderungen entspricht, gehen Sie zu Einrichten der Integration.
Damit die Integration funktioniert, muss das zu verwendende GitHub-Repository folgende Anforderungen erfüllen:
-
Die Manifestdatei muss sich auf der Root-Ebene des GitHub-Repositorys befinden
Die Datei manifest.json muss auf der Root-Ebene des GitHub-Repositorys abgelegt sein, damit Ihr Design hinzugefügt werden kann. Tools und andere zusätzliche Dateien, die ebenfalls dort gespeichert sind, werden beim Importieren in die Wissensadministrator-Oberfläche einfach ignoriert.
-
Das GitHub-Repository kann nur jeweils ein Design enthalten
Sie können in jedem Repository nur jeweils ein Design verwalten. Beim Import des Designs können Sie mit der Branch-Option Variationen Ihres Designs ausprobieren.
So legen Sie Ihr Design in einem GitHub-Repository ab
- Wenn Sie noch kein Design haben, forken Sie das Repository mit dem Design „Copenhagen“ und beginnen Sie, das Design aufzubauen. Auf diese Weise können Sie künftig ganz einfach Verbesserungen aus dem Design „Copenhagen“ in Ihr Design übertragen.
- Wenn Ihr Design in der Wissensadministrator-Oberfläche gespeichert ist, laden Sie Ihr Design herunter, erstellen Sie ein GitHub-Repository (sofern noch nicht vorhanden) und verschieben Sie das Design in das GitHub-Repository.
- Wenn Ihr Design nicht in der Wissensadministrator-Oberfläche oder GitHub gespeichert ist, erstellen Sie ein GitHub-Repository (sofern noch nicht vorhanden) und verschieben Sie Ihr Design in das GitHub-Repository.
Nachdem Sie Ihr Design in GitHub vorbereitet haben, können Sie die Integration einrichten.
Einrichten der Integration
Um die GitHub-Integration einzurichten, müssen Sie sicherstellen, dass das Design in GitHub gespeichert ist. Anschließend können Sie es dann in der Wissensadministrator-Oberfläche von GitHub abrufen. Durch diesen einmaligen Abruf wird die Verbindung zwischen dem Design und GitHub hergestellt.
Nachdem Sie die Integration eingerichtet haben, bearbeiten Sie das Design in GitHub und aktualisieren es dann in der Wissensadministrator-Oberfläche. Anschließend können Sie in der Wissensadministrator-Oberfläche eine Vorschau des Designs anzeigen und das Design veröffentlichen.
So richten Sie die GitHub-Integration mit Ihrem Help-Center-Design ein
- Stellen Sie sicher, dass Sie Ihr Design in GitHub vorbereitet haben.
-
Klicken Sie in der Seitenleiste von Wissensadministrator auf Erscheinungsbild anpassen ().
Die Seite „Designs“ wird geöffnet:
- Klicken Sie oben rechts auf Design hinzufügen.
- Klicken Sie auf Aus GitHub hinzufügen.
- Geben Sie die URL für das Repository und optional einen Branch-Namen ein, wenn Sie das Design von einer anderen Branch als der Standard-Branch abrufen möchten. Klicken Sie dann auf Importieren.
-
Melden Sie sich bei GitHub an, falls Sie dazu aufgefordert werden, und befolgen Sie die Anweisungen, um die GitHub-App Zendesk Theme Importer zu installieren.
Wählen Sie das GitHub-Konto oder die GitHub-Organisation aus, in der sich das Repository befindet, und anschließend die Repositorys, auf die die App zugreifen darf. Wenn Sie ein Administrator der Organisation oder des Repositorys sind, mit dem Sie eine Verbindung herstellen, können Sie die App sofort installieren. Wenn Sie nicht über die erforderlichen Administratorrechte verfügen, sendet GitHub eine Installationsanfrage an einen Organisationsadministrator. Die Integration kann fortgesetzt werden, nachdem ein Administrator die App installiert und ihr Zugriff auf das Repository gewährt hat.
Sobald der Importvorgang abgeschlossen ist, wird das Miniaturbild des Designs auf der Seite „Designs“ angezeigt. Wenn Sie Probleme haben, lesen Sie die Hinweise unter Beheben von Fehlern in der GitHub-Integration für Help-Center-Designs.
Nachdem Sie die Verbindung hergestellt haben, können Sie das Design in GitHub verwalten und bei Bedarf in der Wissensadministrator-Oberfläche aktualisieren.