GitHub

Plans prenant en charge l’intégration des extensionsGitHub avec Document360

Grâce à l’intégration Document360 et GitHub , votre équipe peut lier de manière transparente les articles de la base de connaissances à GitHub problèmes, ce qui permet une meilleure collaboration entre les développeurs et les rédacteurs techniques. Vous pouvez suivre les mises à jour, associer des tâches de documentation aux modifications de code et vous assurer que votre base de connaissances reste synchronisée avec votre processus de développement, le tout sans passer d’une plateforme à l’autre.

Configuration de GitHub dans Document360

Pour configurer GitHub dans Document360, procédez comme suit :

1. Accédez à Settings () > Knowledge base portal > Extensions dans le portail de la base de connaissances.

   Vous pouvez trouver l’extension GitHub dans la section Code repositories .

2. Cliquez Connect sur la vignette de l’extension.

   

   Une nouvelle fenêtre d’installation s’ouvrira.

3. Sélectionnez l’une des deux options en fonction de vos besoins :

   • Tous les dépôts : choisissez de synchroniser tous les dépôts.

   • Ne sélectionnez que des référentiels : choisissez de synchroniser des référentiels spécifiques en fonction des besoins de votre projet.

4. Cliquez sur Install.

   

   Si vous n’êtes pas connecté à GitHub, vous serez redirigé vers l’écran de connexion.

   5. Entrez vos identifiants GitHubet connectez-vous.

   Vous serez redirigé vers le Document360 Knowledge base portal. Le module Create new category apparaîtra.

   6. Sélectionnez GitHub () comme type de catégorie.

   7. Sélectionnez le référentiel dans votre GitHubconfiguré.
   

   1. Une fenêtre contextuelle de confirmation indiquant « Votre GitHub a été lancé avec succès » s’affichera.

      La catégorie de dépôt, ainsi que toutes les branches, sont créées en tant qu’articles dans Document360. Chaque fois qu’un utilisateur GitHub met à jour le référentiel, le contenu est synchronisé avec les articles Document360 mappés.

   2. Vous pouvez identifier chaque entité dans Document360 dans la catégorie GitHub par une icône de branche ().

      

   ---

   Configuration du dépôt Git

   Pour configurer un référentiel Git pour l’accès au contenu dans Document360,

   1. Assurez-vous que votre référentiel Git est correctement configuré pour permettre l’extraction du contenu dans le projet Document360. Suivez la structure ci-dessous :

          Dossier principal :

   • Dans GitHub, le référentiel doit inclure un dossier principal nommé dans docs lequel vous pouvez organiser les sous-dossiers et les articles Markdown.

   • Ce nom de dossier doit rester inchangé.

     
     Stockage des fichiers multimédias :

   • Stockez tous les fichiers multimédias dans le .document360/assets dossier du docs répertoire.

   • Ce nom de dossier doit rester inchangé.

     Par exemple, si une image est référencée dans un fichier nommé « Qu’est-ce que Document360», elle doit être déplacée vers le .document360/assets dossier.

     
     Stockage de l’article :

   • Dans le docs dossier, créez un répertoire séparé, par exemple, articles pour stocker vos articles.

   • Les articles doivent être au format Markdown (.md).

     Insertion de fichiers multimédias dans les articles :

   • Téléchargez le fichier multimédia dans le .document360/assets dossier.

   • Utilisez la syntaxe suivante pour insérer le fichier multimédia dans votre article :

     ![image description](/docs/.document360/assets/mediafilename.extension)

   • Par exemple, si votre fichier multimédia s’appelle test.png, utilisez les éléments suivants :

     ![test image](/docs/.document360/assets/test.png)

Configuration de l’intégration GitHub avec Document360

Vous trouverez ci-dessous un guide vidéo étape par étape sur la configuration et l’intégration transparentes de GitHub à Document360.