Mintlify verwendet eine GitHub-App, um Ihre Dokumentation automatisch mit Ihrem GitHub-Repository zu synchronisieren.

​
Installation der GitHub-App

Installieren Sie die Mintlify-GitHub-App im GitHub-Konto oder in der Organisation, dem/der Ihr Docs-Repository gehört. Sie benötigen Organisationsbesitz oder Administratorberechtigungen im Repository, um die App zu installieren. Wenn Ihnen die erforderlichen Berechtigungen fehlen, muss der/die Repository-Eigentümer:in die Installationsanfrage genehmigen. Installieren Sie die Mintlify-GitHub-App über Ihr Dashboard.
Wir empfehlen, den Zugriff nur auf das Repository zu beschränken, in dem Ihre Docs gehostet werden.
Installationsseite der Mintlify-GitHub-App mit der Option „Only select repositories“ ausgewählt.

​
Berechtigungen

Wenn Sie die GitHub-App installieren, werden Sie aufgefordert, die folgenden Berechtigungen zu erteilen: Leseberechtigungen:
  • metadata: Grundlegende Repository-Informationen
Lese- und Schreibberechtigungen:
  • checks: Statusprüfungen für Pull Requests erstellen
  • code: Dateiänderungen lesen, wenn Sie in Ihren Docs-Branch committen
  • deployments: Vorschau-Bereitstellungen für Pull Requests erzeugen
  • pull requests: Branches und Pull Requests über den Web-Editor erstellen
  • workflows: GitHub Actions für Docs-Bereitstellungen verwalten
Die App greift nur auf Repositories zu, denen Sie ausdrücklich Zugriff gewähren. Wenn Branch-Schutzregeln aktiviert sind, kann die App nicht direkt auf geschützte Branches pushen.

​
Verwalten des Repository-Zugriffs

Bei der Installation unserer GitHub-App können Sie den Zugriff für alle Ihre Repositories oder nur für ausgewählte gewähren. Wir empfehlen, den Zugriff nur für die Repositories zu erteilen, in denen sich Ihre Dokumentation befindet. Sie können diese Auswahl jederzeit in den Einstellungen der GitHub-App ändern.

​
Konfigurieren der Docs-Quelle

Ändern Sie die Organisation, das Repository oder den Branch, aus dem Ihre Dokumentation erstellt wird, im Bereich Git-Einstellungen Ihres Dashboards.

​
Fehlerbehebung

Wenn Sie Probleme mit der GitHub-App haben, kann das Zurücksetzen der Verbindung die meisten Probleme beheben.
1

Deinstallieren Sie die Mintlify-App über GitHub.

  1. Gehen Sie in GitHub zu Installations und wählen Sie neben der Mintlify-App Configure. Scrollen Sie nach unten und wählen Sie Uninstall.
  2. Gehen Sie zu Authorized GitHub Apps und wählen Sie neben der Mintlify-App Revoke.
2

Installieren Sie die Mintlify-App erneut.

  1. Gehen Sie in Ihrem Mintlify-Dashboard zu Git Settings und installieren Sie die GitHub-App.
  2. Autorisieren Sie Ihr Konto im Bereich My Profile Ihres Dashboards.