Utilisation d’un éditeur de texte dans votre environnement local pour créer une page de documentation de destination

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 envoyer une requête de tirage (PR). Avant de passer en revue les étapes indiquées ici, veillez à lire Document de votre destination dans les destinations Adobe Experience Platform.

Connectez-vous à GitHub et configurez votre environnement de création local.

  1. Dans votre navigateur, accédez à https://github.com/AdobeDocs/experience-platform.en

  2. Pour dupliquer le référentiel, cliquez sur Fork comme illustré ci-dessous. Cela crée une copie du référentiel Experience Platform dans votre propre compte GitHub.

    Référentiel de documentation pour les Adobes de transfert

  3. Cloner le référentiel sur votre ordinateur local. Sélectionnez Code > HTTPS > Ouvrir avec GitHub Desktop, comme illustré ci-dessous. Vérifiez que GitHub Desktop est installé. Pour plus d’informations, reportez-vous à la section Création d’un clone local du référentiel dans le guide du contributeur d’Adobe.

    Cloner le référentiel de documentation d’Adobe vers l’environnement local

  4. Dans la structure de fichiers locale, accédez à experience-platform.en/help/destinations/catalog/[...], où [...] est la catégorie souhaitée pour votre destination. Par exemple, si vous ajoutez une destination de personnalisation à Experience Platform, sélectionnez le dossier personalization.

Créez la page de documentation de votre destination.

  1. Votre page de documentation est basée sur le modèle de destination en libre-service. Téléchargez le modèle de destination. Décompressez-le et extrayez le fichier yourdestination-template.md dans le répertoire mentionné à l’étape 4 ci-dessus. Renommez le fichier YOURDESTINATION.md, YOURDESTINATION étant le nom de votre destination dans Adobe Experience Platform. Par exemple, si votre société s’appelle Moviestar, vous nommerez votre fichier moviestar.md.
  2. 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.
    Installation de l’extension Adobe Markdown Author
  3. Modifiez le modèle avec les informations pertinentes pour votre destination. Suivez les instructions du modèle.
  4. Pour toute capture d’écran ou image 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 votre destination. Par exemple, si vous ajoutez une destination de personnalisation à Experience Platform, sélectionnez le dossier personalization. Créez un dossier pour votre destination et enregistrez vos images ici. Vous devez leur créer un lien à partir de la page que vous créez. Voir les instructions pour créer un lien vers des images.
  5. Lorsque vous êtes prêt, enregistrez le fichier sur lequel vous travaillez.

Soumettre votre documentation pour révision

CONSEIL

Notez qu’il n’y a rien que vous puissiez casser ici. En suivant les instructions de cette section, vous proposez simplement une mise à jour de la documentation. Votre mise à jour suggérée sera approuvée ou modifiée par l’équipe de documentation de Adobe Experience Platform.

  1. Dans GitHub Desktop, créez une branche opérationnelle pour vos mises à jour et sélectionnez Publier la branche pour publier la branche sur GitHub.

Nouvelle branche locale

  1. Dans GitHub Desktop, commit votre travail, comme illustré ci-dessous.

    Validation en local

  2. Dans GitHub Desktop, push votre travail vers la branche remote, comme illustré ci-dessous.

    Push your commit

  3. 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. Assurez-vous que la branche sur laquelle vous avez travaillé est sélectionnée et sélectionnez Contribution > Ouvrir la requête d’extraction.

    Créer une requête d’extraction

  4. Assurez-vous que les branches de base et de comparaison sont correctes. Ajoutez une note au document de requête de tirage décrivant votre mise à jour, puis sélectionnez Créer une requête de tirage. Cela ouvre une requête de tirage pour fusionner la branche opérationnelle de votre double dans la branche principale du référentiel Adobe.

    CONSEIL

    Laissez la case Autoriser les modifications par les responsables cochée afin que l’équipe de documentation d’Adobe puisse apporter des modifications au résiduel.

    Création d’une requête d’extraction pour Adobe du référentiel de documentation

  5. À ce stade, une notification s’affiche pour vous inviter à signer le contrat de licence du contributeur Adobe (CLA). Cette étape est obligatoire. Après avoir signé le contrat de licence du contributeur, actualisez la page de requête de tirage et envoyez la requête de tirage.

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

PR réussi

  1. Merci ! L’équipe de documentation de l’Adobe contactera le service des relations publiques si des modifications sont nécessaires et vous indiquera quand la documentation sera publiée.
CONSEIL

Pour ajouter des images et des liens à votre documentation, ainsi que toute autre question concernant Markdown, consultez la section Utilisation de Markdown dans le guide d’écriture collaborative de l’Adobe.

Sur cette page