L’intégration GitHub vous permet de développer et maintenir un thème de façon collaborative dans GitHub, puis d’en afficher l’aperçu et de le publier dans l’Administrateur de Connaissances. Pour configurer l’intégration, vérifiez que votre thème est stocké dans GitHub, puis configurez l’intégration dans l’Administrateur de Connaissances.

Mon édition
Suite, toutes les versions Growth, Professional, Enterprise ou Enterprise Plus
Support avec Connaissances Professional ou Enterprise

Résumé ◀▼

Vous pouvez connecter un thème du centre d’aide dans GitHub à l’Administrateur de Connaissances, puis y afficher un aperçu ou publier les mises à jour. La configuration nécessite que votre référentiel de thèmes contienne un thème et un fichier manifest.json au niveau racine. Cette intégration prend en charge la gestion collaborative des thèmes, les tests en fonction des branches et GitHub Enterprise Cloud, mais pas GitHub Enterprise Server.

Localisation : Administrateur de Connaissances > Panneau de personnalisation () > Ajouter un thème > Ajouter à partir de GitHub

L’intégration GitHub vous permet de développer et maintenir un thème de façon collaborative dans GitHub, puis d’en afficher l’aperçu et de le publier dans l’Administrateur de Connaissances. Pour configurer l’intégration, vérifiez que votre thème est stocké dans GitHub, puis configurez l’intégration dans l’Administrateur de Connaissances.

Remarque – L’intégration GitHub avec le centre d’aide ne prend pas en charge GitHub Enterprise Server, mais elle prend en charge GitHub Enterprise Cloud. Si vous utilisez GitHub Enterprise Server, vous pouvez utiliser l’API Thèmes de Guide.

Vous devez être un administrateur Connaissances pour configurer l’intégration GitHub.

Cet article aborde les sujets suivants :
  • Préparation de votre thème dans GitHub
  • Configuration de l’intégration

Préparation de votre thème dans GitHub

Vous devez vérifier que votre thème se trouve dans GitHub avant de configurer l’intégration dans l’Administrateur de Connaissances. Si vous utilisez Git et GitHub pour la première fois, consultez ce didacticiel. Si votre thème se trouve déjà dans GitHub et s’il satisfait aux exigences suivantes, consultez Configuration de l’intégration.

L’intégration a les exigences suivantes pour votre référentiel GitHub :

  • Le fichier de manifeste doit être à la racine du référentiel GitHub.

    Le fichier manifest.json doit être placé à la racine du référentiel GitHub pour que l’ajout de votre thème soit possible. Vous pouvez encore inclure d’autres fichiers, qui sont ignorés lors de l’importation dans l’Administrateur de Connaissances.

  • Le référentiel GitHub ne peut contenir qu’un seul thème.

    Vous devez gérer un seul thème dans chaque référentiel. Vous pouvez utiliser l’option de branche pendant l’importation du thème pour essayer des variantes de votre thème.

Pour placer votre thème dans un référentiel GitHub

  • Si vous n’avez actuellement aucun thème, utilisez le référentiel du thème Copenhagen et commencez à créer votre thème. Cela vous permettra de facilement porter les améliorations du thème Copenhagen vers votre thème ultérieurement.
  • S’il est dans l’Administrateur de Connaissances, téléchargez votre thème, puis créez un référentiel GitHub (si vous n’en avez pas) et transférez votre thème dans ce référentiel GitHub.
  • Si votre thème n’est ni dans l’Administrateur de Connaissances ni dans GitHub, créez un référentiel GitHub (si vous n’en avez pas) et transférez votre thème dans ce référentiel GitHub.

Une fois que vous avez préparé votre thème dans GitHub, vous êtes prêt à configurer l’intégration.

Configuration de l’intégration

Pour configurer l’intégration GitHub, vous devez vérifier que votre thème est stocké dans GitHub, puis récupérer votre thème dans GitHub pour le transférer dans l’Administrateur de Connaissances. Cette récupération unique établit la connexion entre votre thème et GitHub.

Une fois l’intégration configurée, vous travaillerez sur le thème dans GitHub, puis le mettrez à jour dans l’Administrateur de Connaissances quand vous serez prêt. Vous pourrez alors afficher un aperçu ou publier votre thème dans l’Administrateur de Connaissances.

Pour configurer l’intégration GitHub avec votre thème du centre d’aide

  1. Dans GitHub, vérifiez que vous avez bien préparé votre thème.
  2. Dans Administrateur de connaissances, cliquez sur Panneau de personnalisation () dans la barre latérale.

    La page Thèmes s’ouvre.

  3. Cliquez sur Ajouter un thème dans le coin supérieur droit.
  4. Cliquez sur Ajouter à partir de GitHub.

  5. Saisissez l’URL du référentiel puis, facultativement, saisissez un nom de branche si vous voulez effectuer la récupération à partir d’une branche autre que la branche par défaut, et enfin cliquez sur Importer.

  6. Connectez-vous à GitHub si vous y êtes invité et suivez les invites pour installer l’application GitHub Zendesk Theme Importer.

    Sélectionnez le compte ou l’organisation GitHub où se trouve le référentiel, puis sélectionnez les référentiels auxquels l’application peut accéder. Si vous êtes un administrateur de l’organisation ou du référentiel que vous connectez, vous pouvez installer l’application immédiatement. Si vous n’avez pas les permissions d’administrateur nécessaires, GitHub envoie une demande d’installation à un administrateur de l’organisation. L’intégration peut se poursuivre une fois qu’un administrateur a installé l’application et lui a accordé l’accès au référentiel.

La vignette du thème s’affiche sur la page Thèmes une fois l’importation terminée. Si vous rencontrez des difficultés, consultez Dépannage de l’intégration GitHub pour les thèmes du centre d’aide.

Une fois que vous avez établi la connexion, la gestion de votre thème se fait dans GitHub et sa mise à jour dans l’Administrateur de Connaissances.

Réalisé par Zendesk