DocumentaciónAide

Importer la documentation depuis un dépôt

Comment préparer le dossier docs/usabilidad de votre dépôt pour l'importer dans un espace de connaissances et comment consulter le rapport de chaque importation.

Sur cette page

Si la documentation de votre produit vit dans un dépôt, à côté de son code, vous pouvez la rédiger dans des fichiers Markdown et la laisser s'importer automatiquement dans un espace de Connaissances à chaque modification. Le dépôt devient la source : Elion ITSM crée, met à jour et archive les pages pour vous.

Avant de commencer

  • Une clé d'importation de l'espace enregistrée comme secret dans le dépôt, et la GitHub Action dans le dépôt. Lisez Clés d'importation.

  • Pour consulter le rapport des importations, vous devez disposer du niveau Administrer dans Connaissances (rôle Administrateur).

Comment s'organise le dossier

Toute la documentation se trouve dans le dossier docs/usabilidad/ du dépôt. Chaque dossier est une section du menu et chaque fichier .md est une page, sur 4 niveaux au maximum.

docs/usabilidad/
  index.md                      → portada
  01-primeros-pasos/
    index.md                    → entrada de la sección "Primeros pasos"
    01-iniciar-sesion.md
    02-cambiar-tu-contrasena.md
  02-pedidos/
    index.md
    01-crear-un-pedido.md
    02-despachos/
      index.md
      01-programar-un-despacho.md
  _img/                         → imágenes (no aparece en el menú)
    pedidos-lista.png
  • Ordre. Le numéro du début (01-, 02-) définit l'ordre dans le menu et n'apparaît pas dans l'adresse. Ce qui ne porte pas de numéro vient après, par ordre alphabétique.

  • Adresse. C'est le nom sans le numéro ni .md : 02-pedidos/01-crear-un-pedido.md devient /pedidos/crear-un-pedido. Utilisez des minuscules, sans accents ni espaces, avec des tirets.

  • Sections. Le index.md de chaque dossier est le texte d'introduction de la section. S'il manque, la section est quand même créée avec le nom du dossier.

  • Ignorés. Les dossiers qui commencent par _ ou . (sauf _img) et les fichiers qui ne sont ni des .md ni des images de _img/ ne sont pas importés.

  • Limites. Chaque .md peut peser jusqu'à 1 Mo et chaque image jusqu'à 2 Mo. Le dossier complet, jusqu'à 50 Mo.

L'en-tête de chaque page

Chaque fichier commence par un en-tête placé entre deux lignes --- :

---
title: Crear un pedido
description: Cómo registrar un pedido nuevo y enviarlo a despacho.
tags: [pedidos, despacho]
updated: 2026-10-08
---

Champ

Obligatoire

Usage

title

oui

Titre de la page et du menu (80 caractères maximum).

description

oui

Résumé d'une ou deux lignes (200 caractères maximum). Il apparaît dans la recherche.

tags

non

Étiquettes pour la recherche.

updated

non

Date de la dernière révision du contenu (AAAA-MM-JJ).

menu_title

non

Titre court pour le menu, si title est long.

redirect_from

non

Anciennes adresses de la page, pour ne pas casser les liens si vous la déplacez.

draft

non

true importe la page comme brouillon : elle n'est pas publiée.

Si title ou description contient deux-points suivis d'un espace (: ), écrivez la valeur entre guillemets : description: "Configura el despacho: horario, zonas y costos.". Sans guillemets, l'en-tête n'est pas valide.

Ce que vous pouvez utiliser dans le texte

Élément

Comment l'écrire

Titres

##, ### et ####. Le titre principal est donné par title : n'utilisez pas # dans le texte.

Texte

Paragraphes, gras, italique, code et barré.

Listes

-, 1. et listes de tâches - [ ].

Tableaux

Tableaux GitHub.

Blocs de code

Avec le langage : bash, sh, json, yaml, sql, ts, js, html, css, xml, log ou text.

Citations

>

Encadrés

> [!NOTE], > [!TIP], > [!WARNING] et > [!CAUTION].

Ligne de séparation

---

Liens externes

[texte](https://…). Seulement https: et mailto:.

Liens vers une autre page

Le chemin vers le .md : [Crear un pedido](../02-pedidos/01-crear-un-pedido.md).

Images

Toujours depuis _img/, en PNG, JPEG ou WebP : ![Lista de pedidos](../_img/pedidos-lista.png). Le texte entre crochets est obligatoire.

Le HTML, les iframes, les scripts, les vidéos, les notes de bas de page et les formules ne sont pas acceptés. Ce qui ne figure pas dans le tableau est ignoré à l'importation et noté dans le rapport.

Comment fonctionne chaque importation

L'importation est idempotente : chaque fichier est reconnu par son chemin, et l'exécuter deux fois avec le même contenu ne change rien.

Si le fichier…

Elion ITSM…

est nouveau

crée la page et la publie (ou la laisse en brouillon, avec draft: true).

a changé

crée une nouvelle version et la publie. Dans l'historique, elle porte la mention Importé et le commit.

n'a pas changé

ne fait rien.

a été supprimé

archive la page ; il ne la supprime pas. Si le fichier revient, la page revient avec son numéro et son historique.

a seulement changé de numéro (pour réordonner)

déplace la page et conserve son numéro KB-… et son historique.

Lorsque l'espace est inclus dans le centre d'aide, le site affiche les modifications à la fin de l'importation.

Les pages importées sont en lecture seule

Dans Elion ITSM, une page importée affiche le message Importée depuis … avec son fichier d'origine : Elle se modifie dans le dépôt du produit ; ici elle est en lecture seule (les commentaires restent possibles).

Son éditeur est verrouillé et la page ne peut pas être modifiée depuis Elion ITSM. Pour la corriger, modifiez le fichier dans le dépôt et laissez la prochaine importation la mettre à jour. Lisez Pages importées.

Consulter le rapport des importations

  1. Ouvrez Connaissances et ouvrez l'espace.

  2. Cliquez sur Importations.

La fenêtre Importations de … s'ouvre avec les 20 dernières importations de l'espace, de la plus récente à la plus ancienne. Chacune affiche :

  • la date et depuis combien de temps elle a eu lieu ;

  • l'origine : GitHub Action, Zip importé ou Terminal ;

  • le commit (ses 7 premiers caractères) ;

  • le résumé, par exemple 3 créées · 1 mise à jour · 12 inchangées ;

  • le cas échéant, N avertissements. Cliquez dessus pour voir chacun d'eux avec son fichier.

Les avertissements signalent ce qui a été ignoré ou a dû être ajusté : éléments non acceptés, images manquantes, liens vers des pages qui n'existent pas, en-têtes non valides ou noms qu'il a fallu normaliser. Ils se corrigent dans le dépôt ; la prochaine importation les vérifie à nouveau.

Si l'espace n'a jamais été importé, vous verrez Cet espace n’a encore aucune importation.

Si la GitHub Action échoue, consultez son journal dans l'onglet Actions de GitHub. Une clé révoquée ou expirée est refusée : créez ou renouvelez la clé et mettez à jour le secret.

Voir aussi

Rechercher dans Elion ITSM

Saisissez au moins 2 caractères pour rechercher dans Elion ITSM.

↑↓ naviguer · Enter ouvrir · Esc fermer