Utiliser l’interface web GitHub pour créer une page de documentation de destination github-interface
Les instructions ci-dessous vous montrent comment utiliser l’interface web GitHub pour créer de la documentation et 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.
Configuration de votre environnement de création GitHub set-up-environment
-
Dans votre navigateur, accédez à
https://github.com/AdobeDocs/experience-platform.fr-FR. -
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.
-
Dans le formulaire du référentiel, créez une branche pour votre projet, comme illustré ci-dessous. Utilisez cette nouvelle branche pour votre travail.
-
Dans la structure de dossiers GitHub du référentiel dupliqué, 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 la catégoriepersonalization. Sélectionnez Ajouter un fichier > Créer un fichier.
-
Nommez votre
YOURDESTINATION.mdde destination, où YOURDESTINATION correspond au nom de votre destination dans Adobe Experience Platform. Par exemple, si votre société s’appelle Moviestar, vous devez nommer votre fichiermoviestar.md.
Créer la page de documentation pour la destination author-documentation
-
Vous allez créer le contenu de votre page de destination en fonction du modèle de libre-service de documentation. Téléchargez le modèle et décompressez-le pour extraire le modèle de fichier
.md. -
Collez et modifiez le contenu du modèle avec les informations pertinentes pour la destination dans un éditeur Markdown en ligne, tel que dillinger.io. Suivez les instructions du modèle pour savoir ce que vous devez remplir et quels paragraphes peuvent être supprimés.
note tip TIP Vous pouvez fermer la fenêtre de votre navigateur à tout moment et la rouvrir ultérieurement. Votre travail est enregistré automatiquement et vous attendra lorsque vous rouvrirez le navigateur. 1. Copiez le contenu de l’éditeur Markdown dans votre nouveau fichier dans GitHub.
-
Pour toutes les captures d’écran ou images que vous prévoyez d’utiliser, utilisez l’interface GitHub pour charger les fichiers sur
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 la catégoriepersonalization. Vous devez créer un lien vers les images de la page que vous créez. Voir instructions pour créer un lien vers des images.
-
Lorsque vous êtes prêt, enregistrez le fichier dans votre branche .
Envoi de la documentation pour révision submit-review
-
Après avoir enregistré le fichier et chargé les images souhaitées, vous pouvez ouvrir une demande d’extraction (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 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.fr-FR.
-
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.