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

Connexion à GitHub et configuration de votre environnement de création local set-up-environment

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

  2. À double le référentiel, cliquez sur Branchement 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électionner Code > HTTPS > Ouvrir avec GitHub Desktop, comme illustré ci-dessous. Assurez-vous que GitHub Desktop installé. Voir à ce sujet la section Créer 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 la variable personalization dossier.

Créez la page de documentation de votre destination. author-documentation

  1. Votre page de documentation repose sur les modèle de destination en libre-service. Téléchargez la modèle de destination. Décompressez-le et extrayez le fichier yourdestination-template.md vers le répertoire mentionné à l’étape 4 ci-dessus. Renommer le fichier YOURDESTINATION.md, où YOURDESTINATION est 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 votre éditeur de texte de votre choix. Adobe recommande d’utiliser Visual Studio Code et installez l’extension Adobe Markdown Authoring. Pour installer l’extension, ouvrez Visual Studio Code, sélectionnez la variable Extensions dans la partie 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 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 votre destination. Par exemple, si vous ajoutez une destination de personnalisation à Experience Platform, sélectionnez la variable personalization dossier. 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 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 submit-review

TIP
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 sur la page remote branche , 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 de tirage.

    Création d’une requête d’extraction

  4. Assurez-vous que les branches de base et de comparaison sont correctes. Ajoutez une note au document de présentation, décrivant votre mise à jour, puis sélectionnez Création d’une requête d’extraction. 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.

    note tip
    TIP
    Laissez le champ Autorisation des modifications par les responsables case à cocher sélectionné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 examinant la variable Requêtes de tirage 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.
TIP
Pour ajouter des images et des liens à votre documentation, ainsi que toute autre question concernant Markdown, reportez-vous à la section Utilisation de Markdown dans le guide d’écriture collaborative d’Adobe.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6