Wir verwenden Zugriffstoken und Webhooks, um die Authentifizierung und Synchronisierung von Änderungen zwischen GitLab und Mintlify sicherzustellen.
  • Mintlify verwendet Zugriffstoken, um Informationen aus GitLab abzurufen.
  • GitLab nutzt Webhooks, um Mintlify über Änderungen zu informieren und Vorschau-Bereitstellungen für Merge-Requests zu ermöglichen.

​
Verbindung einrichten

1

Projekt-ID finden

Navigiere in deinem GitLab-Projekt zu Settings > General und suche deine Project ID.
Die Seite General Settings im GitLab-Dashboard. Die Project ID ist hervorgehoben.
2

Access Token erstellen

Navigiere zu Settings > Access Tokens und wähle Add new token.Konfiguriere den Token mit folgenden Einstellungen:
  • Name: Mintlify
  • Role: Maintainer (erforderlich für private Repositories)
  • Scopes: api und read_api
Klicke auf Create project access token und kopiere den Token.
Wenn Project Access Tokens nicht verfügbar sind, kannst du stattdessen einen Personal Access Token verwenden. Beachte, dass Personal Access Tokens ablaufen und regelmäßig aktualisiert werden müssen.
Die Seite Access tokens im GitLab-Dashboard. Die für Mintlify zu konfigurierenden Einstellungen sind hervorgehoben.
3

Verbindung konfigurieren

Im Mintlify-Dashboard:
  1. Gib deine Projekt-ID und deinen Access Token ein.
  2. Nimm alle weiteren erforderlichen Konfigurationen vor.
  3. Klicke auf Save Changes.
Die Seite Git Settings im Mintlify-Dashboard. Die GitLab-Konfigurationseinstellungen sind hervorgehoben.

​
Webhook erstellen

Webhooks ermöglichen es, Ereignisse bei Änderungen zu empfangen, sodass Bereitstellungen automatisch ausgelöst werden können.
1

Navigiere zu Settings > Webhooks und klicke auf 'Add new Webhook'

2

URL und Webhook einrichten

Gib im Feld „URL“ den Endpunkt https://leaves.mintlify.com/gitlab-webhook ein und benenne den Webhook „Mintlify“.
3

Token einfügen

Füge das Webhook-Token ein, das nach dem Einrichten der Verbindung generiert wurde.
4

Ereignisse auswählen

Wähle diese Ereignisse aus, um den Webhook auszulösen:
  • Push events (alle Branches)
  • Merge requests events
Wenn du fertig bist, sollte es so aussehen:
Die Webhook-Seite im GitLab-Dashboard. Die für Mintlify zu konfigurierenden Einstellungen sind hervorgehoben.
5

Webhook testen

Klicke nach dem Erstellen des Webhooks auf das Dropdown „Test“ und wähle „Push events“, um eine Beispiel-Payload zu senden und sicherzustellen, dass alles korrekt konfiguriert ist. Bei korrekter Einrichtung wird „Hook executed successfully: HTTP 200“ angezeigt.So kannst du verifizieren, dass alles funktioniert und deine Dokumentation ordnungsgemäß mit deinem GitLab-Repository synchronisiert wird.