Modification de la documentation sur Microsoft Learn : vue d’ensemble

Merci pour votre intérêt pour la modification de la documentation sur Microsoft Learn ! Vos contributions nous aident à nous assurer que notre documentation est bien rédigée, à jour et qu’elle fournit des informations utiles. Les informations présentes sur cette page vous aideront à décider quelle méthode de contribution vous convient le mieux.

Prérequis

Avant de commencer, vérifiez que vous êtes connecté à votre compte GitHub. Si vous n’avez pas de compte GitHub, accédez à https://github.com/join un processus d’inscription rapide et gratuit.

Modifications mineures apportées à la documentation

Les modifications mineures sont rapides et faciles. Voici quelques exemples de modifications mineures :

  • Correction des fautes de frappe
  • Révision d’un seul article
  • Ajout d’une section à un article
  • Correction d’une erreur
  • Mise à jour des liens rompus

Si vous apportez des modifications mineures, tout ce dont vous avez besoin est un compte GitHub !

Pour apporter une modification mineure, sélectionnez l’icône Modifier ce crayon de document en haut de l’article. Cette action vous dirige vers le fichier source sur GitHub, où vous pouvez apporter vos modifications. Une fois que vous avez terminé, vous êtes invité à créer une demande de tirage (pull request) pour proposer vos modifications. Pour obtenir une procédure pas à pas complète de ce processus, consultez la documentation Modifier dans le navigateur.

Modifications majeures apportées à la documentation

Les changements majeurs impliquent davantage de temps et d’efforts. Voici quelques exemples de changements majeurs :

  • Modifications complexes qui vous permettront de terminer plusieurs jours
  • Révisions de plusieurs articles que vous souhaitez soumettre ensemble
  • Création d’un nouvel article
  • Contribution souvent

Si vous apportez des modifications majeures, vous devez télécharger et installer quelques outils pour faciliter votre travail. Pour commencer, suivez ces étapes :

  1. Installez les outils Git et Markdown.
  2. Configurez un dépôt Git local.
  3. Apportez des modifications à la documentation.
  4. Créez une demande de tirage.

Vue d’ensemble du processus

Le flux de processus ci-dessous montre les étapes générales impliquées dans la prise en main des modifications mineures et majeures. Notez que certains éléments sont des étapes à ne faire qu’une seule fois, tandis que d’autres se répètent à chaque contribution.

Process flow map showing the basic workflow for getting started with the contribution process.

L’image commence par un point de départ simple : s’agit-il de votre première contribution ? Si c’est le cas, l’étape suivante consiste à configurer votre compte GitHub. Dans le cas contraire, l’étape suivante consiste à déterminer si le changement que vous souhaitez apporter est mineur. Si c’est le cas, l’étape suivante consiste à apporter la modification dans le navigateur. Autrement, il est nécessaire d’installer les outils de création, de dupliquer et de cloner le dépôt, d’ouvrir une demande de tirage et de procéder à toutes les vérifications.

Modifications apportées aux modules d’apprentissage

Les contributeurs ne peuvent pas modifier ni proposer de modifications aux modules d’entraînement. Pour l’instant, seule la documentation Microsoft Learn stockée dans les référentiels publics est ouverte pour contributions publiques.