Résolution de problèmes

J’ai une erreur de synchronisation GitHub

Assurez-vous de ne créer des fichiers readme que dans votre dépôt

Lorsque Git Sync est activé, veillez à ne pas créer de fichiers readme via l’interface GitBook. La création de fichiers readme via l’interface GitBook :

• Crée des fichiers README en double dans votre dépôt

• Provoque des conflits d’affichage entre GitBook et GitHub

• Peut interrompre les builds et les processus de déploiement

• Entraîne une priorité de fichier imprévisible

Cela inclut les fichiers nommés README.md, readme.md, Readme.md et README (sans extension). Veillez plutôt à gérer votre fichier README directement dans votre dépôt git.

Vous rencontrez encore des erreurs ?

Assurez-vous que :‌

• Votre dépôt contient un README.md fichier à sa racine (ou dans le root dossier spécifié dans votre .gitbook.yaml) qui a été créé directement dans votre dépôt git. Ce fichier est requis et est utilisé comme page d’accueil de votre documentation. Pour plus de détails, consultez notre configuration du contenu.

• Si vous avez des frontmatters YAML dans vos fichiers Markdown, assurez-vous qu’ils sont valides à l’aide d’un linter.​

​GitBook n’utilise pas mon dossier docs dossier

Par défaut, GitBook utilise la racine du dépôt comme point de départ. Un répertoire spécifique peut être indiqué pour délimiter les fichiers Markdown. Consultez notre documentation sur configuration du contenu pour plus de détails.‌

GitBook crée de nouveaux fichiers Markdown

Lors de la synchronisation et de l’édition depuis GitBook avec un dépôt git existant, GitBook peut créer de nouveaux fichiers Markdown au lieu d’utiliser ceux qui existent déjà.‌ Cela est fait pour garantir que GitBook n’écrase pas les fichiers qui existaient dans votre dépôt avant.

Les redirections ne fonctionnent pas correctement

Le fichier YAML doit être correctement formaté pour que les redirections fonctionnent. Des erreurs telles qu’une indentation incorrecte ou des espaces blancs peuvent empêcher vos redirections de fonctionner. Valider votre fichier YAML peut garantir que les redirections fonctionneront correctement.

Lors de la configuration des redirections, n’ajoutez pas de slash initial. Par exemple, essayer de rediriger vers ./misc/support.md ne fonctionnera pas.

Il est également important de noter que tant qu’une page existe pour un chemin, GitBook ne recherchera pas une redirection possible. Donc, si vous configurez une redirection d’une ancienne page vers une nouvelle, vous devrez supprimer l’ancienne page pour que la redirection fonctionne.

​Mon dépôt n’est pas सूची?

Pour les dépôts GitHub

Assurez-vous d’avoir installé l’application GitHub de GitBook aux emplacements corrects (lors de l’installation de l’application, vous pouvez choisir de l’installer sur votre GitHub personnel ou sur toute organisation pour laquelle vous avez des autorisations) et d’avoir accordé à l’application les autorisations correctes sur le dépôt.

Pour les dépôts GitLab

Assurez-vous que votre jeton d’accès a été configuré avec les accès suivants :

• api

• read_repository

• write_repository

​Il ne se passe rien sur GitBook après l’ajout d’un nouveau fichier à mon dépôt

Cette section traite spécifiquement des problèmes lorsqu’un SUMMARY.md fichier existe déjà

Si votre dépôt ne contient pas de SUMMARY.md fichier, GitBook en créera automatiquement un lors de la première synchronisation. Cela signifie que si vous avez modifié votre contenu depuis GitBook au moins une fois après avoir configuré la synchronisation Git, GitBook aurait dû créer ce fichier automatiquement.‌

Si, après avoir mis à jour votre dépôt en ajoutant ou en modifiant un fichier Markdown, vous ne voyez pas la mise à jour apparaître sur GitBook et que la barre latérale n’indique aucune erreur pendant la synchronisation, il est probable que vos fichier(s) modifié(s) ne soient pas répertorié(s) dans votre SUMMARY.md fichier.

Cela peut être dû soit au fait que vous avez créé le fichier manuellement, soit au fait que vous avez effectué une modification sur GitBook et que la phase d’export de GitBook vers Git de la synchronisation l’a créé pour vous.

Le contenu de ce fichier reflète votre table des matières sur GitBook et est utilisé pendant la phase d’import de Git vers GitBook de la synchronisation pour recréer votre table des matières et réconcilier les prochaines mises à jour du dépôt avec votre contenu existant sur GitBook.‌

Si, après avoir vérifié que tous vos fichiers sont inclus dans le fichier SUMMARY.md il ne se passe toujours rien sur GitBook, n’hésitez pas à contacter le support pour obtenir de l’aide.

L’aperçu GitHub ne s’affiche pas

Si votre aperçu GitHub ne s’affiche pas, cela peut être dû au fait que votre intégration GitSync a été configurée avant janvier 2022. Les versions de GitSync configurées avant cette date n’incluent pas l’aperçu GitHub.

Vous auriez dû recevoir une notification vous demandant d’accepter une demande d’autorisation mise à jour afin d’activer l’accès en lecture seule aux PR.

Si vous n’avez pas reçu la notification, pour dépanner vous devez passer à la nouvelle version :

1. Désinstallez l’intégration GitSync de votre organisation.

2. Réinstallez la nouvelle version avec les autorisations mises à jour.

Veuillez noter que la désinstallation de l’intégration GitSync nécessitera de reconfigurer l’intégration à nouveau sur tous les espaces auxquels elle était précédemment connectée.

Comptes potentiellement dupliqués lors de la connexion

Cette erreur se produit généralement lorsque le compte GitHub que vous utilisez pour configurer la synchronisation est déjà associé à un autre compte utilisateur GitBook.

Une bonne façon d’identifier à quel compte GitBook le compte GitHub est déjà lié est la suivante :

1. Déconnectez-vous de votre session utilisateur GitBook actuelle (c.-à-d. [e-mail])

2. Déconnectez-vous de toutes les sessions utilisateur GitHub.

3. Accédez à la page de connexion.

4. Sélectionnez l’option « Se connecter avec GitHub ».

5. Saisissez vos identifiants GitHub.

6. Une fois connecté, allez dans les paramètres du compte puis soit :

   1. Dissociez le compte depuis la section « Connexion tierce > GitHub » dans le paramètre Personnel

   2. Supprimez complètement le compte si vous n’en avez pas besoin.

7. Déconnectez-vous de la session.

8. Reconnectez-vous avec votre [e-mail] compte GitBook.

9. Essayez de configurer à nouveau Git Sync.