Wanneer ontwikkelaars nieuwe code of updates committen in een GitHub-repository, moeten overeenkomstige wijzigingen vaak in je kennisbank worden weergegeven. Het handmatig aanmaken of updaten van Document360-artikelen voor elke commit kost veel tijd en is foutvatbaar. Door GitHub en Document360 via Zapier te verbinden, kun je dit automatiseren: telkens wanneer een gespecificeerd evenement plaatsvindt in een GitHub-repository, maakt Zapier automatisch een overeenkomstig artikel aan in je Document360-kennisbank.
Wanneer deze integratie te gebruiken
- Je engineeringteam volgt een docs-as-code benadering en wil dat elke GitHub zich aanmeldt voor een specifieke repository om automatisch een conceptartikel in Document360 te genereren voor beoordeling.
- Je onderhoudt een changelog of kennisbank met release notes in Document360 en wilt dat nieuwe commits of releases op GitHub automatisch het aanmaken van artikelen starten.
- Je ontwikkelworkflow omvat documentatie-updates naast codewijzigingen, en je wilt ervoor zorgen dat kennisbasisartikelen synchroon worden gemaakt zonder een handmatige stap.
Voordat je begint
- Je moet ingelogd zijn op je Zapier-account.
- Je moet een GitHub-account hebben met toegang tot de repository die je wilt monitoren.
- Je moet je Document360 API-token klaar hebben. Om er een te genereren, ga je naar Connections > Extensions, zoek je de Zapier-tegel en klik je op Connect om het token te kopiëren.
Hoe de Zap op te zetten
Stap 1 — Maak een nieuwe Zap aan
- Log in op je Zapier-account.
- Klik in het linker navigatiemenu op Aanmaken en selecteer Zaps.
- Er wordt een nieuwe Zap gemaakt met een Trigger - en Actieflow .
Stap 2 — Verbind GitHub als trigger
- Kies in het Trigger-veld GitHub.
- Selecteer in het veld Trigger event het event dat de Zap moet activeren.
OPMERKING
Om later de trigger-app te wijzigen, klik je op Wijzigen in het Trigger-veld.
- Klik op het Account-veld — er verschijnt een inlogpaneel.
- Voer je GitHub-gegevens in en klik op Zapier autoriseren.
- Kies de gewenste repository en klik op Doorgaan. Zapier voert een test uit om te bevestigen dat de trigger correct is ingesteld.
Stap 3 — Verbind Document360 als actie
- Kies in het actieveld Document360.
- Selecteer in het Setup-paneel het gewenste evenement in het Event-veld .
- Klik op het Account-veld — er verschijnt een inlogpaneel.
- Voer je inloggegevens in en klik op Toestaan.
Om het API-token te genereren vanuit Document360:
- Navigeer naar Connections > Extensions in de linker navigatiebalk van het Knowledge Base-portaal.
- Klik op de Zapier-extensietegel op Verbinden.
- Klik op het kopieer-icoon om het token te kopiëren.
- Ga terug naar het Zapier-paneel en plak het API-token in het veld.
- Klik op ja, ga door naar document360.
- Je kunt het verbonden Document360-project vinden op de Connect Document360-accountpagina . Om later een ander account te gebruiken, klik je op Wijzigen.
- Klik op Doorgaan.
Stap 4 — Kaart de velden in kaart
- Map de velden van GitHub naar Document360:
| Veld | Beschrijving |
|---|---|
| Titel | Standaard is Nieuwe Commit in GitHub geselecteerd. Andere opties zijn beschikbaar afhankelijk van jouw behoeften. |
| Inhoud | Standaard is Commit Message geselecteerd. Andere opties zijn beschikbaar afhankelijk van jouw behoeften. |
| Versie | Kies de werkruimte in je Document360-project waar het artikel gemaakt moet worden. |
| Taal | Kies de taal binnen de geselecteerde werkruimte. |
| Categorie | Selecteer de categorie waarin het artikel wordt aangemaakt. |
| Publiceren | Stel het artikel in op True om het artikel direct te publiceren. Stel het op False om het als concept op te slaan. |
OPMERKING
De knop Doorgaan wordt pas ingeschakeld nadat alle vereiste velden zijn toegewezen.
- Klik op Doorgaan.
Stap 5 — Test en publiceer de Zap
- Klik in het testgedeelte op Verzenden Test.
- Als het lukt, krijg je het bericht Test Artikel verzonden! Controleer je Document360-account om het te bekijken.
- In je Document360-portaal vind je een nieuw artikel getiteld "Nieuwe commit in GitHub" in de door jou geselecteerde categorie.
- Ga terug naar het Zapier-setuppaneel en klik op Volgende, en klik vervolgens op Publiceren.
- Je zult een succesbericht zien: je Zap staat aan. Klik op Beheer je Zap om naar de Zap-overzichtspagina te gaan.
Zap overzicht
Zodra het actief is, kun je de Zap bekijken en beheren vanuit het Zapier-dashboard. De overzichtspagina toont de trigger, actie en loopgeschiedenis van de Zap.
Hoe verwijder je een Zap
- Navigeer naar het Zapier-dashboard. Een lijst van alle bestaande Zaps wordt weergegeven op de overzichtspagina.
- Klik op het Zap-acties () icoon rechts van de Zap die je wilt verwijderen en klik op Verwijderen. De Zap is permanent verwijderd.
Best practices
- Stel het veld Publish in op False bij het mappen van velden, zodat door GitHub-getriggerde artikelen als concepten in Document360 terechtkomen. Dit geeft je documentatieteam de kans om de inhoud te beoordelen, te formatteren en te verrijken voordat deze live gaat — omdat ruwe commit-berichten zelden klaar zijn om te publiceren zoals ze zijn.
- Gebruik een speciale categorie in Document360 voor door GitHub-getriggerde artikelen, zoals een categorie "Changelog" of "Dev updates". Dit houdt automatisch gegenereerde content gescheiden van handgemaakte artikelen en maakt het makkelijker om te beoordelen en te promoten.
- Kies een specifieke triggergebeurtenis die past bij je workflow — bijvoorbeeld een push naar een release-branch in plaats van elke commit — om te voorkomen dat je artikelen genereert voor elke routinematige codewijziging die geen kennisbasisvermelding rechtvaardigt.