Documentation Experience Platform Guide des connecteurs sources

Utiliser un éditeur de texte dans votre environnement local pour créer une page de documentation sur les sources

Dernière mise à jour : 5 mai 2025

Rubriques :

Créé pour :

Développeur

Ce document décrit les étapes à suivre pour utiliser votre environnement local afin de créer de la documentation pour votre source et d’envoyer une requête de tirage (PR).

CONSEIL

Les documents suivants du guide de contribution d’Adobe peuvent être utilisés pour continuer à prendre en charge votre processus de documentation :

Conditions préalables

Le tutoriel suivant nécessite l’installation préalable de GitHub Desktop sur votre ordinateur local. Si vous ne disposez pas de GitHub Desktop, vous pouvez télécharger l’application ici.

Connexion à GitHub et configuration de votre environnement de création local

La première étape de la configuration de votre environnement de création local consiste à accéder au référentiel GitHub de Adobe Experience Platform.

platform-repo

Sur la page principale du référentiel GitHub d’Experience Platform, sélectionnez Branchement.

fourche

Pour cloner le référentiel sur votre ordinateur local, sélectionnez Code. Dans le menu déroulant qui s’affiche, sélectionnez HTTPS puis Ouvrir avec le bureau GitHub.

CONSEIL

Pour plus d’informations, consultez le tutoriel sur la configuration locale du référentiel Git pour obtenir de la documentation.

open-git-desktop

Ensuite, patientez quelques instants le temps que GitHub Desktop clone le référentiel experience-platform.en.

clonage

Une fois le processus de clonage terminé, accédez à GitHub Desktop pour créer une branche . Sélectionnez Principal dans la barre de navigation supérieure, puis sélectionnez Nouvelle branche

nouvelle-branche

Dans le panneau contextuel qui s’affiche, saisissez un nom explicite pour votre branche, puis sélectionnez Créer une branche.

create-branch-vs

Sélectionnez ensuite Branche de publication.

publish-branch

Créer la page de documentation pour votre source

Avec le référentiel cloné sur votre ordinateur local et une nouvelle branche créée, vous pouvez maintenant commencer à créer la page de documentation de votre nouvelle source via l’éditeur de texte de votre choix.

Adobe vous recommande d’utiliser Visual Studio Code et d’installer l’extension de création Adobe Markdown. Pour installer l’extension, lancez Visual Studio Code, puis sélectionnez l’onglet Extensions dans le volet de navigation de gauche.

extension

Ensuite, saisissez Adobe Markdown Authoring dans la barre de recherche, puis sélectionnez Installer dans la page qui s’affiche.

installer

Une fois votre ordinateur local prêt, téléchargez le modèle de documentation sources et extrayez le fichier à experience-platform.en/help/sources/tutorials/api/create/... avec [...] représentant la catégorie de votre choix. Par exemple, si vous créez une source de base de données, sélectionnez le dossier de base de données.

Enfin, suivez les instructions indiquées sur le modèle et modifiez le modèle avec les informations pertinentes relatives à votre source.

edit-template

Envoi de la documentation pour révision

Pour créer une requête de tirage (PR) et envoyer votre documentation pour révision, enregistrez d’abord votre travail dans Visual Studio Code (ou l’éditeur de texte de votre choix). Ensuite, à l’aide de GitHub Desktop, saisissez un message de validation et sélectionnez Valider pour créer-la-documentation-source.

commit-vs

Ensuite, sélectionnez Pousser l’origine pour charger votre travail dans la branche distante.

push-origin

Pour créer une demande d’extraction, sélectionnez Créer une demande d’extraction.

create-pr-vs

Vérifiez que les branches de base et de comparaison sont correctes. Ajoutez une note au PR décrivant votre mise à jour, puis sélectionnez Créer une demande d’extraction. Cela ouvre une requête de tirage pour fusionner la branche de travail de votre travail dans la branche principale du référentiel Adobe.

CONSEIL

Laissez la case Autoriser les modifications par les responsables sélectionnée pour vous assurer que l’équipe de documentation d’Adobe peut apporter des modifications à la requête de modification.

create-pr

Vous pouvez confirmer que la demande d’extraction a été envoyée en examinant l’onglet Demandes d’extraction dans https://github.com/AdobeDocs/experience-platform.en.

confirm-pr

recommendation-more-help