GitHub

Synchronisez votre documentation avec un référentiel GitHub

Mintlify utilise une GitHub App pour synchroniser automatiquement votre documentation avec votre référentiel GitHub.

​

Installation de l’application GitHub

Installez la GitHub App Mintlify sur le compte ou l’organisation GitHub qui détient votre référentiel de documentation. Vous devez être propriétaire de l’organisation ou disposer des autorisations d’administrateur sur un référentiel pour installer l’application. Si vous n’avez pas les autorisations nécessaires, le propriétaire du référentiel devra approuver la demande d’installation.

Installez la GitHub App Mintlify depuis votre Dashboard.

Nous vous recommandons d’accorder l’accès uniquement au référentiel où votre documentation est hébergée.

​

Autorisations

Lorsque vous installez l’app GitHub, il vous sera demandé d’accorder les autorisations suivantes :

Autorisations de lecture :

• metadata : Informations de base du référentiel

Autorisations de lecture et d’écriture :

• checks : Créer des vérifications d’état sur les pull requests (demandes de fusion)
• code : Lire les modifications de fichiers lorsque vous faites un commit sur votre branche de documentation
• deployments : Générer des déploiements de prévisualisation pour les pull requests (demandes de fusion)
• pull requests : Créer des branches et des pull requests (demandes de fusion) depuis l’éditeur web
• workflows : Gérer GitHub Actions pour les déploiements de la documentation

L’app n’accède qu’aux référentiels auxquels vous lui avez explicitement accordé l’accès. Si vous avez activé des règles de protection de branche, l’app ne peut pas pousser directement vers les branches protégées.

​

Gérer l’accès aux référentiels

Lors de l’installation de notre GitHub App, vous pouvez accorder l’accès à l’ensemble de vos référentiels ou uniquement à certains d’entre eux. Nous recommandons de n’accorder l’accès qu’aux référentiels où se trouve votre documentation. Vous pouvez modifier cette sélection à tout moment dans vos paramètres de l’application GitHub.

​

Configurer la source de la documentation

Modifiez l’organisation, le référentiel ou la branche à partir desquels votre documentation est générée dans la section Git Settings de votre Dashboard.

​

Résolution des problèmes

​

Problèmes de connexion avec l’application GitHub

Si vous rencontrez des problèmes avec l’application GitHub, réinitialiser la connexion permet de résoudre la plupart des cas.

1. Désinstallez l’application Mintlify via GitHub.

   1. Dans GitHub, allez aux installations et sélectionnez Configure à côté de l’application Mintlify. Faites défiler vers le bas et sélectionnez Uninstall.
   2. Allez sur Authorized GitHub Apps et sélectionnez Revoke à côté de l’application Mintlify.
2. Réinstallez l’application Mintlify.

   1. Dans votre Tableau de bord Mintlify, allez dans Git Settings et installez la GitHub App.
   2. Autorisez votre compte dans la section My Profile de votre Tableau de bord.

​

Les modules complémentaires de feedback sont indisponibles

Si vous ne pouvez pas activer les options de suggestions d’édition ou de signalement de problèmes dans votre Tableau de bord Mintlify et que votre référentiel est public, revalidez vos paramètres Git.

1. Accéder aux paramètres Git

   Accédez aux paramètres Git dans votre Tableau de bord Mintlify.

2. Revalider vos paramètres

   Cliquez sur la coche verte dans le coin du cadre des paramètres Git pour revalider les paramètres de votre référentiel. Cela forcera la mise à jour de vos paramètres afin de refléter si votre référentiel est public ou privé.