Partager via

Cloner et mettre à jour le contenu wiki hors connexion

Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022

Le processus de mise à jour du wiki hors connexion est identique au développement de code dans un dépôt Git. Vous pouvez utiliser vos outils de ligne de commande git et client préférés pour mettre à jour vos pages wiki hors connexion. Pour plus d’informations sur l’utilisation des dépôts Git et des outils pris en charge, consultez la documentation Git d’Azure Repos.

Les étapes de base pour mettre à jour le contenu wiki hors connexion sont les suivantes :

  1. Clonez votre dépôt Git wiki vers votre environnement de développement interactif local (IDE) ou votre espace de travail.

  2. Ajoutez des fichiers ou des dossiers à votre branche de dépôt Git locale.

  3. Mettez à jour les fichiers .order pour refléter les modifications de séquence pour les pages et les sous-pages.

  4. Validez et envoyez les mises à jour à votre branche Git locale.

Prérequis

Catégorie Spécifications
Accès au projet Membre du projet où se trouvent les wikis. Vous pouvez demander l’accès auprès de votre administrateur de projet, si nécessaire.
Autorisations - Membre du groupe de contributeurs .
- Pour publier du code en tant que wiki, créez une autorisation de dépôt . Par défaut, cette autorisation est définie pour les membres du groupe Administrateurs de projet .
Niveaux d’accès Au moins un accès de base.
Tâches - Comprendre la structure sous-jacente de votre dépôt Git wiki.
- Comprendre les différences entre un wiki provisionné et un code publié en tant que wiki.

Cloner votre wiki

Votre référentiel wiki stocke les pages, les images, les pièces jointes et la séquence de pages et de sous-pages. Clonez votre wiki pour commencer.

  1. Connectez-vous à votre projet (https://dev.azure.com/<Organization>/<Project>).

  2. Sélectionnez votre wiki, puis sélectionnez Autres actions (...) >Cloner le wiki :

    Capture d’écran montrant comment sélectionner l’action Git Plus d'options Clone du wiki pour le wiki sélectionné.

  3. Dans la boîte de dialogue Cloner le référentiel, sélectionnez l'icône Copier l'URL de clonage dans le Presse-papiers :

    Capture d’écran montrant le dépôt wiki à cloner dans la boîte de dialogue Cloner le référentiel.

  4. Collez l’URL dans votre navigateur. La page du référentiel Git s’ouvre dans laquelle vous pouvez afficher les fichiers définis sous la branche wikiMain. L’exemple suivant montre les fichiers du dépôt Git pour le projet CanaryBuilds :

    Capture d’écran montrant la page du référentiel Git avec les fichiers définis sous la branche wikiMain.

    Important

    La fonctionnalité Générer des informations d’identification Git est prévue pour la suppression. Consultez la documentation sur l’authentification Git pour toutes les méthodes d’authentification disponibles pour les opérations de clone Git.

  5. Utilisez l’URL que vous avez copiée pour cloner le dépôt dans votre IDE préféré. Pour plus d’informations, consultez les articles suivants :

Ajouter des pages à votre dépôt Git local

Les pages de dépôt Git sont mises en forme en tant que fichiers Markdown (.md). Pour chaque page que vous souhaitez ajouter à votre wiki, vous créez un fichier Markdown dans votre branche locale. Après avoir ajouté des pages, vous mettez à jour le fichier .order pour ajuster la séquence de pages afin d’inclure les nouvelles pages.

Ajouter des pages

Vous pouvez ajouter des pages en haut de la structure wiki dans le dossier racine (\) et également dans d’autres dossiers.

  1. Créez le fichier Markdown (.md) avec le contenu de la nouvelle page. Dans la plupart des cas, le nom du fichier correspond au titre de la page. Dans le nom du fichier, remplacez les espaces du titre par des traits d’union (-). Pour plus d’informations sur la création de contenu de page, consultez Ajouter une page wiki.

  2. Placez le fichier dans le dossier souhaité dans la structure wiki de votre branche locale, par exemple le dossier racine. L’exemple de dossier racine du projet CanaryBuilds est C:\Users\UserName\Source\Repos\CanaryBuilds.wiki:

    Capture d’écran montrant la branche locale du dépôt Git wiki pour le projet CanaryBuilds.

  3. Mettez à jour le fichier .order dans le même dossier que celui où vous avez placé le nouveau fichier de page. Le texte d’entrée de la page est le nom de fichier sans l’extension Markdown (.md). L’exemple de projet CanaryBuilds ajoute la nouvelle page « Comment contribuer », qui correspond au texte d’entrée Comment contribuer :

    Welcome
Roadmap  
How-to-contribute  
Home  
Reference

    Pour plus d’informations sur le fichier .order , consultez la séquence de pages et le fichier .order.

Ajouter des sous-pages

Vous pouvez également créer des sous-pages pour une page dans votre wiki :

  1. Créez un dossier pour servir de page parente. Pour plus d’informations, consultez La structure des fichiers et dossiers du référentiel.

  2. Créez le fichier Markdown pour chaque sous-page et placez le fichier dans le dossier de page parent. L’exemple de projet CanaryBuilds ajoute le dossier How-to-contribute en tant que page parente :

    Capture d’écran montrant le dossier How-to-contribution dans le projet CanaryBuilds avec de nouvelles sous-pages.

  3. Créez un fichier .order dans le dossier de page parent pour définir la séquence des sous-pages, car ils doivent s’afficher dans le wiki. L’exemple montre un ordre possible de sous-pages :

    Request-extensions  
Licensing  
Smoke-test  
Coding-guidelines

Envoyer vos modifications

Lorsque vos mises à jour locales sont prêtes, envoyez les fichiers au dépôt Git.

Les pages et sous-pages ajoutées apparaissent immédiatement dans votre wiki. L’exemple suivant montre les mises à jour du projet CanaryBuilds :

Capture d’écran montrant la structure wiki mise à jour pour le projet CanaryBuilds.

S’il existe des erreurs dans le processus, la page apparaît dans votre liste de fichiers wiki avec un symbole d’avertissement :

Capture d’écran montrant une page avec une erreur, comme indiqué par le symbole Avertissement.

Contenu connexe

  • Last updated on