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, assurez-vous d'être connecté à votre compte GitHub. Si vous n'avez pas de compte GitHub, rendez-vous sur https://github.com/join pour une procédure d'inscription rapide et gratuite.
Modifications mineures de la documentation
Les modifications mineures sont rapides et faciles. Voici quelques exemples de modifications mineures
- Correction de fautes de frappe
- Révision d'un seul article
- Ajout d'une section à un article
- Correction d'une erreur
- Mise à jour de liens brisés
Si vous apportez des modifications mineures, il vous suffit d'avoir un compte GitHub !
Pour apporter une modification mineure, sélectionnez l'icône du crayon Éditer ce document en haut de l'article. Cette action vous permet d'accéder au fichier source sur GitHub, où vous pouvez effectuer vos modifications. Lorsque vous aurez terminé, vous serez invité à créer une requête de retrait (PR) pour proposer vos modifications. Pour une procédure-à-pas complète de ce processus, consultez la rubrique Modifier la documentation dans le navigateur.
Modifications majeures de la documentation
Les modifications majeures nécessitent plus de temps et d'efforts. Voici quelques exemples de modifications majeures
- des modifications complexes qui vous prendront plusieurs jours
- Révisions de plusieurs articles que vous souhaitez soumettre ensemble
- Création d’un nouvel article
- Contribution fréquente
Si vous apportez des modifications importantes, vous devez télécharger et installer quelques outils pour faciliter votre travail. Pour commencer, suivez ces étapes :
- Installez les outils Git et Markdown.
- Configurez un dépôt Git local.
- Apporter des modifications à la documentation.
- Créez un PR.
Vue d’ensemble du processus
Le diagramme de processus ci-dessous montre les étapes de haut niveau nécessaires pour bien démarrer les 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.
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 des modules de formation
Les contributeurs ne peuvent pas modifier ou proposer des changements aux modules de formation. À l'heure actuelle, seule la documentation Microsoft Learn stockée dans des référentiels publics est ouverte aux contributions publiques.