Utiliser un éditeur de texte dans votre environnement local pour créer une page de documentation de destination local-authoring
Les instructions de cette page vous montrent comment utiliser un éditeur de texte pour travailler dans votre environnement local afin de créer de la documentation et d’envoyer une requête de tirage (PR). Avant de suivre les étapes indiquées ici, veillez à lire Documenter la destination dans les destinations Adobe Experience Platform.
Connexion à GitHub et configuration de votre environnement de création local set-up-environment
-
Dans votre navigateur, accédez à
https://github.com/AdobeDocs/experience-platform.en -
Pour brancher le référentiel, cliquez sur Branchement comme illustré ci-dessous. Une copie du référentiel Experience Platform est ainsi créée dans votre propre compte GitHub.
-
Clonez le référentiel sur votre ordinateur local. Sélectionnez Code > HTTPS > Ouvrir avec le bureau GitHub, comme illustré ci-dessous. Vérifiez que GitHub Desktop est installé. Pour plus d’informations, consultez la section Création d’un clone local du référentiel dans le guide du contributeur d’Adobe.
-
Dans votre structure de fichiers locale, accédez à
experience-platform.en/help/destinations/catalog/[...], où[...]est la catégorie souhaitée pour la destination. Par exemple, si vous ajoutez une destination de personnalisation à Experience Platform, sélectionnez le dossierpersonalization.
Créer la page de documentation pour la destination author-documentation
- Votre page de documentation est basée sur le modèle de destination libre-service. Téléchargez le modèle de destination. Décompressez-le et extrayez le fichier
yourdestination-template.mddans le répertoire mentionné à l’étape 4 ci-dessus. Renommez le fichierYOURDESTINATION.md, où YOURDESTINATION correspond au nom de la destination dans Adobe Experience Platform. Par exemple, si votre société s’appelle Moviestar, vous devez nommer votre fichiermoviestar.md. - Ouvrez votre nouveau fichier dans 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, ouvrez Visual Studio Code, sélectionnez l’onglet Extensions à gauche de l’écran, puis recherchez
adobe markdown authoring. Sélectionnez l’extension et cliquez sur Install.
- Modifiez le modèle avec les informations pertinentes pour la destination. Suivez les instructions du modèle.
- Pour toutes les captures d’écran ou images que vous prévoyez d’ajouter à votre documentation, accédez à
GitHub/experience-platform.en/help/destinations/assets/catalog/[...], où[...]est la catégorie souhaitée pour la destination. Par exemple, si vous ajoutez une destination de personnalisation à Experience Platform, sélectionnez le dossierpersonalization. Créez un dossier pour la destination et enregistrez vos images ici. Vous devez créer un lien vers ces pages à partir de la page que vous êtes en train de créer. Voir instructions pour créer un lien vers des images. - Lorsque vous êtes prêt, enregistrez le fichier sur lequel vous travaillez.
Envoi de la documentation pour révision submit-review
- Dans le bureau GitHub, créez une branche de travail pour vos mises à jour, puis sélectionnez Publier la branche pour publier la branche sur GitHub.
-
Dans le bureau GitHub, validez votre travail, comme illustré ci-dessous.
-
Dans le Bureau GitHub, poussez votre travail vers la branche distante, comme illustré ci-dessous.
-
Dans l’interface web GitHub, ouvrez une requête de tirage (PR) pour fusionner votre branche de travail dans la branche principale du référentiel de documentation d’Adobe. Vérifiez que la branche sur laquelle vous avez travaillé est sélectionnée et sélectionnez Contribuer > Ouvrir la demande d’extraction.
-
Assurez-vous 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. Cette action ouvre une requête de tirage pour fusionner la branche de travail de votre branchement dans la branche principale du référentiel Adobe.
note tip TIP Laissez la case Autoriser les modifications par les responsables sélectionnée afin que l’équipe de documentation d’Adobe puisse apporter des modifications à la requête de modification. 
-
À ce stade, une notification s’affiche vous invitant à signer le contrat de licence du contributeur (CLA) d’Adobe. Il s’agit d’une étape obligatoire. Après avoir signé le contrat de licence du contributeur, actualisez la page de requête de tirage et envoyez la demande d’extraction.
-
Vous pouvez confirmer que la demande d’extraction a été envoyée en consultant l’onglet Demandes d’extraction dans
https://github.com/AdobeDocs/experience-platform.en.
- Merci ! L’équipe de documentation d’Adobe contactera le service de presse si des modifications sont nécessaires et pour vous informer de la date de publication de la documentation.