GitHub

Offres prenant en charge cette fonctionnalité : Business Enterprise

Avec l'intégration Document360 et GitHub , votre équipe peut relier sans effort les articles de la base de connaissances aux problèmes GitHub , permettant une meilleure collaboration entre développeurs et rédacteurs techniques. Vous pouvez suivre les mises à jour, associer les 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, tout cela sans changer de plateforme.

Configuration de GitHub dans Document360

Pour configurer GitHub dans Document360,

Naviguer vers Connections () > Extensions dans la barre de navigation de gauche du portail de la base de connaissances.
Vous pouvez trouver l'extension GitHub dans la section Code repositories .
Cliquez sur Connect sur la tuile d'extension.
Un nouveau panneau d'installation s'ouvrira.
Choisissez l'une des deux options selon vos besoins :
- Tous les dépôts - choisissez de synchroniser tous les dépôts.
- Sélectionnez uniquement des dépôts – choisissez de synchroniser des dépôts spécifiques selon les besoins de votre projet.
Install.

2_Screenshot-Authorization_page Si vous n'êtes pas connecté GitHub, vous serez redirigé vers l'écran de connexion.

Saisissez vos identifiants GitHub et connectez-vous. Vous serez redirigé vers le Knowledge base portal Document360. Le module Create new category apparaîtra.
Sélectionnez GitHub () comme type de catégorie. Sélectionnez le dépôt depuis votre GitHub configuré.

Une boîte de confirmation indiquant « Votre GitHub a été lancé avec succès » apparaîtra.

La catégorie dépôt, ainsi que toutes les branches, est créée en tant qu'articles dans Document360. Chaque fois qu'un utilisateur GitHub met à jour le dépôt, le contenu est synchronisé avec les articles Document360 mappés.
Vous pouvez identifier chaque entité dans Document360 dans la catégorie GitHub par une icône de branche ().

Mise en place d'un dépôt Git
Pour configurer un dépôt Git pour l'accès au contenu dans Document360,
Assurez-vous que votre dépôt Git est correctement configuré et configuré pour permettre l'extraction du contenu dans le projet Document360. Suivez la structure ci-dessous :
Dossier principal :
- Dans GitHub, le dépôt doit inclure un dossier principal nommé docs où l'on peut organiser les sous-dossiers et les articles Markdown.
- Le nom de ce dossier doit rester inchangé.
  Stockage des fichiers multimédias :
- Stockez tous les fichiers médias dans le .document360/assets dossier du docs répertoire.
- Le nom de ce 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 dans le .document360/assets dossier.
  Stockage des articles :
- Dans le docs dossier, créez articles par exemple un répertoire séparé pour stocker vos articles.
- Les articles doivent être au format Markdown (.md).
  Insertion de fichiers médias dans les articles :
- Téléversez le fichier média dans le .document360/assets dossier.
- Utilisez la syntaxe suivante pour insérer le fichier média dans votre article :
```
![image description](/docs/.document360/assets/mediafilename.extension)
```
- Par exemple, si votre fichier média porte un nom test.png, utilisez :
```
![test image](/docs/.document360/assets/test.png)
```

FAQ

Les comptes d'équipe peuvent-ils modifier ou publier les articles créés dans la catégorie GitHub ?

Les comptes d'équipe ne peuvent pas modifier ni publier les articles créés dans la catégorie GitHub. Si des modifications doivent être apportées, modifiez le dépôt source sur GitHub et les modifications seront synchronisées avec l'article Document360 .

Comment fonctionnent l'importation et l'exportation ?

L'intégration prend en place une synchronisation unidirectionnelle, de GitHub vers Document360. Une fois connecté, la structure de votre dépôt GitHub est reproduite telle qu'elle est dans Document360. L'exportation de contenu de Document360 vers GitHub n'est pas prise en charge.

Quand on pousse un commit sur GitHub, est-ce que cela pousse automatiquement une compilation sur Document360 ?

Oui. Lorsque vous commencez des modifications dans votre branche GitHub liée, les mises à jour sont automatiquement synchronisées et publiées dans Document360.

Peut-on prévisualiser ou modifier des articles GitHub dans Document360 ?

Non. Les articles synchronisés sur GitHub sont en lecture seule dans Document360. Vous ne pouvez pas modifier ou prévisualiser des versions non publiées dans Document360. Les articles synchronisés seront déjà publiés et ne pourront être modifiés que sur GitHub.

Dois-je déclencher la synchronisation manuellement ?

Non. Une fois la connexion GitHub configurée, Document360 extrait et publie automatiquement les mises à jour dès que des commits sont poussés.

Existe-t-il des brouillons ou un historique de révisions pour les articles synchronisés ?

Non, l'historique des versions et le suivi des modifications ne sont pas disponibles pour les articles synchronisés GitHub dans Document360.

Puis-je créer de nouvelles pages dans Document360 pour des projets GitHub ?

Vous ne pouvez créer de nouvelles pages que sur GitHub. La structure des dossiers et des articles sur GitHub est reproduite exactement dans Document360. La création de nouveaux articles n'est pas autorisée dans Document360 pour les catégories synchronisées sur GitHub.