Integration von GitHub mit Document360 mittels Zapier

Wenn Entwickler neuen Code oder Updates in ein GitHub-Repository eintragen, müssen entsprechende Änderungen oft in Ihrer Wissensdatenbank widergespiegelt werden. Das manuelle Erstellen oder Aktualisieren von Document360-Artikeln für jeden Commit ist zeitaufwendig und fehleranfällig. Indem Sie GitHub und Document360 über Zapier verbinden, können Sie dies automatisieren: Wann immer ein bestimmtes Ereignis in einem GitHub-Repository auftritt, erstellt Zapier automatisch einen entsprechenden Artikel in Ihrer Document360-Wissensdatenbank.

Wann sollte diese Integration verwendet werden

• Dein Engineering-Team folgt einem Docs-as-Code-Ansatz und möchte, dass jeder GitHub sich in ein bestimmtes Repository einsetzt, um automatisch einen Entwurf eines Artikels in Document360 zur Überprüfung zu generieren.
• Du führst eine Changelog oder Release Notes Wissensdatenbank in Document360 und möchtest, dass neue Commits oder Releases in GitHub automatisch die Artikelerstellung auslösen.
• Ihr Entwicklungsworkflow umfasst Dokumentationsupdates neben Codeänderungen, und Sie möchten sicherstellen, dass Knowledge Base-Artikel synchron und ohne manuellen Schritt erstellt werden.

Bevor du anfängst

• Du musst in deinem Zapier-Konto eingeloggt sein.
• Du musst ein GitHub-Konto haben, das Zugriff auf das Repository hat, das du überwachen möchtest.
• Sie müssen Ihr Document360-API-Token bereit haben. Um eine zu generieren, navigiere zu Verbindungen > Erweiterungen, suche die Zapier-Kachel und klicke auf Verbinden, um das Token zu kopieren.

Wie man den Zap einrichtet

Schritt 1 — Erstellen Sie einen neuen Zap

1. Melden Sie sich in Ihrem Zapier-Konto an.
2. Im linken Navigationsmenü klicken Sie auf Erstellen und wählen Sie dann Zaps.
3. Ein neuer Zap wird mit einem Trigger- und Aktionsfluss erstellt.

Schritt 2 – GitHub als Trigger verbinden

1. Im Trigger-Feld wähle GitHub.
2. Im Feld "Trigger-Ereignis " wähle das Ereignis aus, das den Zap auslösen sollte.

3. Klicken Sie auf das Kontofeld – ein Anmeldefeld erscheint.
4. Geben Sie Ihre GitHub-Zugangsdaten ein und klicken Sie auf Zapier autorisieren.
5. Wählen Sie das gewünschte Repository aus und klicken Sie auf Fortsetzen. Zapier führt einen Test durch, um zu bestätigen, dass der Trigger korrekt konfiguriert ist.

Schritt 3 – Koppeln Sie Document360 als Aktion an

1. Im Aktionsfeld wählen Sie Document360.
2. Im Einstellungsfeld wählen Sie im Ereignisfeld das gewünschte Ereignis aus.
3. Klicken Sie auf das Kontofeld – ein Anmeldefeld erscheint.
4. Geben Sie Ihre Anmeldedaten ein und klicken Sie auf Erlauben.

Um das API-Token aus Document360 zu generieren:

5. Navigieren Sie in der linken Navigationsleiste des Knowledge Base-Portals zu Verbindungen > Erweiterungen.
6. Auf der Zapier-Erweiterungskachel klicken Sie auf Verbinden.

7. Klicken Sie auf das Kopieren-Symbol, um das Token zu kopieren.

8. Gehe zurück zum Zapier-Panel und füge das API-Token ins Feld ein.
9. Klicken Sie auf Ja, fahren Sie zu document360 fort.

10. Das verbundene Document360-Projekt finden Sie auf der Kontoseite Connect Document360 . Um später ein anderes Konto zu verwenden, klicken Sie auf Ändern.
11. Klicken Sie auf Weitermachen.

Schritt 4 — Abbildung der Felder

1. Mappe die Felder von GitHub zu Document360:

2. Klicken Sie auf Weitermachen.

Schritt 5 – Teste und veröffentliche den Zap

1. Im Testbereich klicken Sie auf Test senden.
2. Wenn Sie erfolgreich sind, erhalten Sie die Nachricht Testartikel! Überprüfe dein Document360-Konto, um es anzusehen.
3. In Ihrem Document360-Portal finden Sie einen neuen Artikel mit dem Titel "Neuer Commit in GitHub" in der gewählten Kategorie.
4. Gehe zurück zum Zapier-Setup-Panel und klicke auf Weiter, dann auf Veröffentlichen.
5. Du wirst eine Erfolgsbotschaft sehen: Dein Zap ist aktiviert. Klicken Sie auf "Ihr Zap verwalten ", um zur Zap-Übersichtsseite zu gelangen.

Zap-Übersicht

Sobald es aktiv ist, können Sie den Zap über das Zapier-Dashboard ansehen und verwalten. Die Übersichtsseite zeigt den Auslöser, die Aktion und den Laufverlauf des Zap.

Wie man einen Zap löscht

1. Navigiere zum Zapier-Dashboard. Eine Liste aller bestehenden Zaps wird auf der Übersichtsseite angezeigt.
2. Klicken Sie auf das Zap-Aktionen ()-Symbol rechts neben dem Zap, den Sie entfernen möchten, und klicken Sie auf Löschen. Der Zap wird dauerhaft gelöscht.

Best Practices

• Setze das Publicer-Feld beim Zuordnung von Feldern auf Falsche , sodass von GitHub ausgelöste Artikel als Entwürfe in Document360 landen. Das gibt Ihrem Dokumentationsteam die Möglichkeit, die Inhalte vor dem Veröffentlichen zu überprüfen, zu formatieren und zu bereichern – da rohe Commit-Nachrichten selten bereit sind, wie sie sind, veröffentlicht zu werden.
• Verwenden Sie eine eigene Kategorie in Document360 für von GitHub ausgelöste Artikel, wie zum Beispiel eine Kategorie "Changelog" oder "Dev Updates". Dadurch werden automatisch generierte Inhalte von handgefertigten Artikeln getrennt und es einfacher gemacht, sie zu überprüfen und zu bewerben.
• Wählen Sie ein spezifisches Trigger-Ereignis, das zu Ihrem Workflow passt – zum Beispiel ein Push zu einem Release-Branch statt zu jedem Commit –, um zu vermeiden, dass Artikel für jede routinemäßige Codeänderung generiert werden, die keinen Eintrag in die Knowledge Base rechtfertigt.